Standards

When you are working with our API, you may notice that you encounter responses frequently. These are intentional and intended to both assist you and the API with handling proper connections.

Missing Authentication

If you are making a request and you send malformed request, either an authentication scheme that we don't recognize or an invalid one, the server will return a 401 Unauthorized response. An example is shown below.

HTTP/1.1 401 Unauthorized
Content-Type: application/json
Content-Length: 39

{"success":false,"data":"Unauthorized"}

OPTIONS requests

If you intend on making a request to the server, it's recommended that you perform an OPTIONS request. This will return the valid options on the endpoint you've specified. If any exist, they will be sent in the Allow header and also provided in the response body.

HTTP/1.1 200 OK
Allow: GET, OPTIONS
Content-Type: application/json
Content-Length: 58
WWW-Authenticate: Bearer

{"success":true,"data":{"methods":["GET","OPTIONS"]}}

Server timeouts

If the server does not send a response within 10000ms of the endpoint being called on the server side, your client will be returned a status of 500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 75
WWW-Authenticate: Bearer

{"success":false,"data":"Internal server error. Please try again later"}