Page History

...

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:

pdf_ranked (Only ranked document)
pdf_all (All documents)
excel_ranked (Only ranked document)
excel_all (All documents)
word_ranked (Only ranked document)

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

Code Block

language	actionscript3
firstline	1
title	HTTPS Success Response 200 OK
linenumbers	true

{
    "status": "success",
    "message": "Report has been successfully fetched",
    "data": "<Complete document encoded in Base64 format>"
 }

Error Response:

Code Block

language	actionscript3
firstline	1
title	No valid API-key
linenumbers	true

{
    "status": "error",
    "message": "API key is not valid"
}

Code Block

language	actionscript3
firstline	1
title	Wrong Case id
linenumbers	true

{
    "status": "error",
    "message": "You dont have permission to do that"
}

Sample call (cURL)

Code Block

language	actionscript3
firstline	1
title	Sample cURL
linenumbers	true

curl --location --request GET 'https://api.ipscreener.com/v1/download' \
--header 'key: Auth-key' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'case=20990' \
--data-urlencode 'type=word_ranked'

...

Page tree

Versions Compared

Old Version 26

New Version 27

Key