Developer docs

Документация API

Основные правила запросов, авторизации и формата ответа для интеграции с сервисом.

Запросы

Общие правила

HTTP-method: GET

Response Body:

  • success - показывает, выполнен ли запрос успешно: true или false
  • data - содержит результат метода или описание ошибки
Пример успешного ответа:
{
    "success": true,
    "data": {
        "property_name": "value",
        "second_property_name": "anotherValue"
    }
}
Пример ответа с ошибкой:
{
    "success": false,
    "data": {
        "name": "Unauthorized",
        "code": 0,
        "status": 401
    }
}
Доступ

Authentication

It passes with the token API. You can see and change it to settings

Безопасность


Храните токен только в защищённых системах и не передавайте его третьим лицам. Если доступ мог быть раскрыт, сгенерируйте новый токен в настройках: прежний будет деактивирован.

Ответ

Response format

Allowed format: JSON, XML The format is set depending on the value Accept header.

Format for JSON:
Accept: application/json
Format for XML:
Accept: application/xml
For set a strict response format use GET-param _format
Example _format=json