Skip to main content

Basic concepts of the API mechanism.

The system is managed using the HTTP protocol.

The principle of requests is based on requests for piti and POST data.

Authorization is required before starting work with the API. After successful authorization, the client will be given an access token, which will be used to authorize all other requests.
With each request, you must pass an access token as a parameter.

Request Structure

http://<cluster>:<port>/api/<path>

POST data: "access_token" = <access_token>

 

The response from the server will be in the form of standard JSON.

{
 "msg": "",
 "status": "",
 "error": ""
}

msg - Returns the data requested by the request, if successful.

status - Request status. Returns the following values: error, success, true, fals

error - Returns the error text.