Postman shared collection
https://www.getpostman.com/collections/edc3eb18512ec586e47a
How to Import Postman collection
Warning | ||
---|---|---|
| ||
All our API's requires https (encrypted) connections , do not use http |
POST idea
URL: https://api.ipscreener.com/v1/idea Method: POST Headers Required: Body Required: Username=[string] Reference=[string] Title=[string] Summary=[string] Header authorization : An API authorization key must be sent with all requests. You need to contact the IPscreener support team to get the API authorization key. Body Username: What user is making the request. Must be an valid email. If the email adress dosen't already exist, the system will create a new user. Reference: Reference name for your case/search. Title: The title of your idea, which is included in the search quary. Summary: A description of your idea. Recommended length is half a A4-page or more. (note: a request MUST contain a few words or your search won't process.
data: the session ticket value associated with a search request used to GET and PUT the search results. case: Your case Id used to GET/PUT your search results. url: A url to your search result inside IPscreener with automatic login. expire: a ticket is valid for 1 hour before expired and ticket is invalid. Time is displayed in UNIX Note Supported languages: english, german, french, japanese. | Success Response Body content format: JSON The below response will be returned once the search request has been processed. To view the result please use the GET idea API with the case value.
Error Responses The below response will be returned if a requierd field is missing or left blank. (Username, Reference, Title or Summary.)
The below response will be returned if the e-mail format is wrong. E.g "#test@e.mail
The below response will be returned if the e-mail is already in use on another account.
The below response will be returned if your API key is wrong or invalid.
The below response will be returned if your query is to short or language is unsupported.
| ||||||||||||||||||||||||||||||||||||||||||
Sample Call (cURL)
|
GET idea
URL: https://api.ipscreener.com/v1/idea Method GET Headers authorization=[value] Body Case=[value] Success Response: Header authorization : An API authorization key must be sent with all requests. You need to contact the IPscreener support team to get the API authorization key. Body Case: the session ticket value associated with a search request used to GET the search results. Success Response: index value: After the parameter automatch-result there is an integer value, e.g. index-1. This value indicates the specific index and associated settings used for performing the matching procedure. If several indexes are targeted with a search (maximum three in parallel), each result list will be presented separately, one after the other. position: The position refers to the record number of the hit in the search results, where the search results are sorted on the relevance score value in descending order. rating: Rating refers to your ranking made; background, relevant or similar. Noise or unranked documents won't appear. image: It creates a link to the first image, if one exist. Images file type is .png. note: Comments made on this document. document type: Can be two different types
kind-code: The kind codes are used to identify the type of patent publication. More information on this syntax is available at: www.wipo.org. Some of the most common kind codes are:
publication-date: The publication date is the date on which a patent application/grant is first published. It is the date on which the document is made available to the public. priority-date: Priority date refers to the earliest filing date in a family of patent applications. title (array): This section includes the full title of the patent.
abstract (array): This is the summary describing the essence of the scope of a patent.
claim (array): A claim defines exactly what is claimed by the invention and therefore what is sought to be protected. It clearly lays down what the patent does and does not cover.
description (array): The detailed description describes in detail what the invention is and how it is made and used. It reflects the complete picture of the invention.
inventor (array): This field provides information about the inventor(s).
applicant (array): This field provides information about the patent owner(s) or applicant(s).
class (array): The classification scheme is a system of codes that groups inventions according to technical area, where IPC and CPC is the most common. The class information is divided into the follwoing hierarchy, including four sections:
passage: Shows the paragraph within a document that the AutoMatch engine considered to be most relevant to the query.
| Success Response: Body content format: JSON When checking if data is ready for retrieval you only use the parameter ticket value. The response below will be returned once the search request has been processed and is ready for delivery.
When no ranking or only noise has been assigned to documents. It still consider it as a successful response and return and empty request.
Error Response The below response will be returned if your API key is wrong or invalid.
The below response will be returned if your case id is wrong, invalid or when you try to open a case id that belongs to another customer/company
Sample Call (cURL)
|
PUT idea
URL: https://api.ipscreener.com/v1/idea Method: PUT Headers authorization=[value] Body case=[value] Success Response data: contains all case data case: the session ticket value associated with a search request used to PUT the search results. url: a new URL token is generated. expire: how long a case id is valid. Before expiring. Time is displayed in UNIX | Success Response: Body content format: JSON When checking if data is ready for retrieval you only use the parameter ticket value. The response below will be returned once the search request has been processed and is ready for delivery. This API is used to retrive data from an expired ticket.
Error Response The below response will be returned if your API key is wrong or invalid.
The below response will be returned if your case token is;
Sample Call (cURL)
|
GET Download
URL: https://api.ipscreener.com/v1/download Method: GET Headers required: authorization=[value] Body required: case=[integer] type=[keyword] Header: authorization: An API authorization key must be sent with all requests. You need to contact the IPscreener support team to get the API authorization key. Body: case: case id from POST idea. type: Export options, they are case sensative:
E.g type=pdf_all Success Response data: Retrieval of a complete PDF, Excel or Word document encoded in Base64 format. | The Download API is used to retrieve the original patent document(s) corresponding to a search query. From the requested case id, the API request returns a PDF,Excel or Word file in base64 format based on ranking. Success Response: Body content format: JSON
Error Response:
Sample call (cURL)
|