Обзор
HOST: https://домен_системы/api/v2
Авторизация
Авторизация производится при помощи Basic Authorization, в качестве параметров необходимо передавать э-почту пользователя и API-ключ.
API ключ администратора системы можно найти по пути Управление -> Глобальные настройки -> Система
Ключи других пользователей можно найти в карточке пользователя (ключи видны только главному администратору).
Пример заголовка авторизации:
Authorization: Basic bmlraXRhLmFudG9ub3ZAaGVscGRlc2tlZGR5LmNvbTphMzI4NThiNC1hNjVlLTQ5ZWYtY=
Ключ в заголовке "Authorization: Basic" - это комбинация email:api_key закодированной с помощью 'base64'
Права доступа
Каждый пользователь в системе имеет собственный API-ключ, ключ можно получить в карточке пользователя или при создании пользователя
Ответы API всегда фильтруются в соответствии с разрешениями пользователя, данные которого используются для авторизации.
В правах доступа допущены некоторые условные разрешения для полноценной интеграции через одного пользователя.
Ограничения скорости
API ограничено количеством запросов в минуту (RPM). Лимит RPM для вашей системы указан в ответе от API в заголовке X-Rate-Limit. В случае превышения лимита доступ будет автоматически заблокирован на 20 минут.
Обязательно используйте следующие заголовки ответов, чтобы узнать текущий лимит скорости для системы и отслеживать количество запросов, которые можно отправить в данную минуту:
X-Rate-Limit: 300 // текущий лимит скорости (RPM)
X-Rate-Limit-Remaining: 299 // оставшееся количество запросов в данную минуту
Для запросов к Базе Знаний устанавлены отдельные лимиты.