Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Getting Started
  10. Step 3: API Call & Common Responses

Step 3: API Call & Common Responses

You can only call APIs that your app is authenticated to after completing the authentication step. You have to pass your authentication token in the query string of every API you call. You can find more details about each API parameters and responses in the following sections of the documentation. Below is list of responses common for all APIs in this documentation:

Common Responses

Status Response
400 Bad Request 
{
    "result": false,
    "title": "Bad Request",
    "message": "Missing one or more URL parameters."
}
400 Bad Request 
{
    "result": false,
    "title": "Bad Request",
    "message": "Authorization token required."
}
401 Unauthorized 
{
    "result": false,
    "title": "Unauthorized",
    "message": "Invalid or expired token."
}
401 Unauthorized 
{
    "result": false,
    "title": "Unauthorized",
    "message": "Invalid IP address."
}

You are invoking the API from a different IP address than the one from which you originally authenticated.

401 Unauthorized 
{
    "result": false,
    "title": "Unauthorized",
    "message": "Invalid account."
}

You are invoking the API on a different account than the one from which you originally authenticated.

401 Unauthorized 
{
    "result": false,
    "title": "Unauthorized",
    "message": "Invalid app ID."
}

You are invoking the API using an app that is no more valid.

401 Unauthorized 
{
    "result": false,
    "title": "Unauthorized",
    "message": "Token belongs to an app that is not authorized to call this API."
}
403 Forbidden 
{
    "result": false,
    "title": "Forbidden",
    "message": "The account you are trying to access is suspended."
}
404 Not Found 
{
    "result": false,
    "title": "Not Found",
    "message": "The account you are trying to access is not found."
}
404 Not Found 
{
    "result": false,
    "title": "Not Found",
    "message": "The API you are trying to access is not found."
}
405 Method Not Allowed 
{
    "result": false,
    "title": "Method Not Allowed",
    "message": "HTTP method is not allowed."
}
501 Not Implemented 
{
    "result": false,
    "title": "Not Implemented",
    "message": "HTTP method is not implemented."
}