Skip to content

General info

  • UTF-8 encoding is used in every request and server response
  • Only JSON format is used in every request and response
  • Every request should be made using HTTPS
  • If an employee identifier is required, please provide e-mail or Calamari user login
  • Usage of this API is limited. You can make 10 requests/second, 720 requests/hour, 2880 requests/day. If you need more contact with us.
  • Please note that every once in a while, a new parameters can appear in JSON responses. Please include this in your client.

Authentication

Before you can use Calamari API, you have to enable "API Access" in configuration panel. Please keep generated ApiKey in secret. Every method in this API is authenticated using HTTP Basic Authentication (more info).

As username use calamari. As password use the API key generated in Calamari configuration panel.

Responses

Returned HTTP status code indicates method result according to specification (more info). In case of an error, Calamari API may additionally return corresponding error code. Possible value depends on method but there are some common error codes:

  • AUTH - Authentication failure. There are two possible reasons: disabled API access or invalid ApiKey provided. Used when returned HTTP status code is 401.
  • HTTP_METHOD_NOT_ALLOWED - HTTP method not allowed, please verify HTTP method of the request. Used when returned HTTP status code is 405.
  • INVALID_METHOD_URL - HTTP method not allowed, please verify HTTP method of the request. Used when returned HTTP status code is 404.
  • QUOTA_EXCEEDED - Too many requests in a given amount of time. Used when returned HTTP status code is 429.
  • INVALID_JSON_PAYLOAD - Json object you sent cannot be interpreted by server. Please check object format and provided data due to api specification.
  • UNKNOWN_ERROR - We don't know what happened but will investigate.

Terms of use and changes policy

Responses and requests objects can be extended. If you cannot recognize a json object attribute, just ignore it. Here you can find terms of use of all Calamari services.

Previous page