REST API

Авторизация

Авторизация клиента в сервисе производится на основании токена доступа.

При совершении действий в сервисе, токен доступа необходимо передавать в HTTP заголовке X-Api-Key.

Формат ответа

Ответ сервиса имеет следующий формат:

{
  "error": {
    "code": "string",
    "message": "string",
    "data": "string"
  },
  "data": ...
}

Поле data содержит результат выполнения запроса в случае его успешности. В случае ошибки поле data будет равно null.

Поле error описывает ошибку, возникшую в результате выполнения запроса, где:

• code - код ошибки,
• message - сообщение об ошибке,
• data - данные, связанные с ошибкой.

В случае успешного выполнения запроса поле error будет равно null.