Introduction
Endpoint
Action name | get products |
|---|---|
HTTP path | /api/doc/get/{token}
|
HTTP method | POST |
Attributes of the HTTP request
hash | string | required | An unique identifier of the document. |
|---|---|---|---|
bToken | string | required | An unique identifier of the broker. |
Attributes of the HTTP response
Success response | |||
|---|---|---|---|
JSON array of objects containing: | |||
pdfbinary | string | required | An attribute that contains document’s content, in base64 format. |
Failed response | |||
error | string | required | It contains a reason for the failed request. |
Examples
HTTP Request without profession filter |
# HTTP POST
# /api/doc/get/{:token}
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
"hash": "some encrypted string",
"bToken": "some encrypted string"
}
|
HTTP Request with profession filter |
# HTTP POST
# /api//doc/get/{token}
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
"token": "some long string value",
"professionId": 123
}
|
Successful HTTP Response |
# HTTP 200 status code
# 'Content-Type': 'application/json'
{
"pdfbinary": "a long hashed string"
}
|
Failed HTTP Response |
# HTTP 200 status code
# 'Content-Type': 'application/json'
{
"error": "API User is not existing or deactivated."
}
|