The Burq API is REST based and uses JSON encoded with UTF-8 for the format of its request and response payloads. As such, endpoints are invoked using standard HTTP verbs (GET, POST, etc) and resources are identified using URIs.
All API requests are sent over HTTPS.
Requests for our sandbox and production environments (see API Authentication ) are accessed via the following URI:
HTTP Status Codes
The following HTTP Status Codes used by the Burq API.
Status Code | Description | Most Likely Cause |
|---|---|---|
200 | Successful | Everything worked as expected. |
304 | Not Modified | |
400 | Bad Request | Invalid/missing data |
401 | Unauthorized | Invalid/missing credentials |
404 | Not Found | The server can not find the requested resource |
429 | Too Many Requests | The client has exceeded the API rate limit |
500 | Internal Server Error | An error occurred within the Burq application. |