Appearance
What to expect from us
Doppio uses conventional HTTP response codes to be sure everyone can understand the responses returned by our API. The meaning of these codes is explained in the following table:
Status code | Meaning | Description |
---|---|---|
200 | OK | Successful request, everything worked well. |
400 | Bad Request | The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large...). |
401 | Unauthorized | No valid API key provided. |
403 | Forbidden | Inactive subscription or subcription that does not include the requested functionnality. |
404 | Not Found | The requested resource doesn't exist. |
413 | Payload Too Large | The body you sent is too big - ask support. |
422 | Unprocessable Entity | The total number of requests exceeds your subscription model. |
429 | Too Many Requests | Too many requests have been sent to the server in a short amount of time. |
5xx | Server Error | An error occured on Doppio's server. |
Error Response
If a request is not successful, our API returns a JSON containing 3 fields: statusCode
message
and error
as following:
json
{
"statusCode": 400,
"message": [
"page.goto.url must be an URL address"
],
"error": "Bad Request"
}
statusCode
and error
are the same as in the table above. message
contains more details of the error if available. There can be several errors for the same statusCode
. Here are a few examples of messages you could find for a Bad Request
error:
page.goto.url must be an URL address
page.setContent.html must be base64 encoded
Unexpected token } in JSON at position 96