Requests are sent by POST method using HTTP/1.1 protocol. The method is also mentioned on each request description page.
Request parameters are placed in the sent structure. Some parameters can be sent in URL (API key, format).
The input data format must be indicated in the Content-Type HTTP header.
Possible header values:
application/json — JSON format
- application/xml - XML format
Symbols must have UTF-8 coding.
API token must be sent in request parameters for authorization. Example:
API token can be created in the user panel, in section "Settings" - "Tokens". Master user rights are necessary to create a token.
API token is automatically generated after saving. You can also select a token name and configure access rights (in roles) and groups of objects available for this token.
The response format can be selected in the request header or parameters.
Response example (Successful operation):
The following parameters are given in responses:
- error - error code
- error_text - error description
- profile_id - profile identifier (for successful operation)
Operation is successful
API token required
Tariff limit reached
No rights for this action
The object is not found in the token vision zone
Another record with the same unique attributes already exists
The database is not available in the selected resource
Requested Content-Type is not supported
Ambiguous search, there are several objects with given attributes
The object belongs to another group
|450||Request validation error|
Internal service error
The method does not exist
If the connection fails at the moment of receiving the data, a second request may be sent. The platform will not accept a repeated request if it modifies the data in order to avoid duplicate events. Read more about repeated requests here.