Overview

Authentication

You authenticate against the API using HTTP Basic Authenication described in FC 2617 using Auhtorization HTTP header. Credentials are provided by Your client manager.

Server responses

Response will always contain at least four parameters:

1. statusCode - HTTP status code indicating nature of the response (machine readable)
2. status - Status indicating more specific description of the result (machine readable)
3. message - Human readable message, useful for error messages
4. data - Response from specific API endpoint, if any (object or array)

Status codes

Most common status codes are listed here:

• 200 - Request was successfull
• 4XX - Client side error
  • 400 - Input data is invalid
  • 401 - Invalid or missing username/password
  • 404 - Resource or API endpoint does not exist
  • 410 - Resource is not longer available
• 5XX - Server issues, try again in a few minutes