The JSON response is a dictionary whose keys are detailed below:
Key | Description | Format |
status | « success » | STRING |
error_type | Error label: details in the following table | STRING |
error_id | Error code: details in the following table | STRING(2) |
Detail of error codes :
error_id | error_type | Description |
01 | invalid request | the request is not correct (wrong parameters) |
03 | invalid client secret | the value in client_secret is not correct |
22 | unauthorized client | your license is not authorized |
30 | invalid or expired token | invalid or expired token |
31 | unsupported grant type | the value in grant_type is not supported |
98 | credits exhausted | you have used all your credit |
Response example :
- Code 98 :
{
"status": "error",
"error_type": "Credits exhausted",
"error_id": "98"
}
- Code 01 (invalid request, ex: missing license, missing parameter, etc.) :
{
"status": "error",
"error_id": "01",
"error_type": "invalid request"
}
In case of an error in a parameter (e.g.: clien_secret instead of client_secret), an error 500 will be returned.