API Routes

All API accesses are done over HTTPS.

Authentication process

Authentication is done via HTTP headers. For more information, see the Authorization section below.

Request Format

Send the request parameters through the request body:

  • with a JSON string using a POST method, or
  • through a query string using a GET method.

Response Format

The response format for all requests is a JSON object. The HTTP status code shows whether a request has succeeded or not. A 2xx status code means success. Any other code means a failure occurred.


When a request fails, the response body is still in JSON.