Developer docs
Документация API
Основные правила запросов, авторизации и формата ответа для интеграции с сервисом.
Запросы
Общие правила
HTTP-метод: GET
Тело ответа:
- success - показывает, выполнен ли запрос успешно: true или false
- data - содержит результат метода или описание ошибки
{
"success": true,
"data": {
"property_name": "value",
"second_property_name": "anotherValue"
}
}
Пример ответа с ошибкой:
{
"success": false,
"data": {
"name": "Unauthorized",
"code": 0,
"status": 401
}
}
Доступ
Аутентификация
Проходит с помощью API токена. Его Вы можете посмотреть и изменить в настройкахБезопасность
Храните токен только в защищённых системах и не передавайте его третьим лицам. Если доступ мог быть раскрыт, сгенерируйте новый токен в настройках: прежний будет деактивирован.
Ответ
Формат ответа
Доступные форматы: JSON, XML. Формат устанавливается в зависимости от содержимого свойства Accept в заголовке запроса.
Accept: application/jsonФормат для XML:
Accept: application/xmlЧтобы выставить строгий формат ответа - используйте GET-свойство
_format. Пример:
_format=json