Перейти к основному содержимому

Loop REST API

Справочник методов REST API v4 сервера Loop: пользователи, команды, каналы, сообщения, файлы, интеграции и администрирование. Описания методов приведены на английском языке.

Базовый адрес​

https://your-loop-server.ru/api/v4

Все запросы и ответы — в формате JSON, если в описании метода не указано иное (например, для загрузки файлов).

Аутентификация​

Передавайте токен в заголовке Authorization:

curl -H 'Authorization: Bearer <токен>' https://your-loop-server.ru/api/v4/users/me

Где взять токен:

  • Персональный токен доступа — для скриптов и интеграций от имени пользователя.
  • Токен бот-аккаунта — для постоянных интеграций, не привязанных к сотруднику.
  • Токен сеанса — метод POST /users/login возвращает его в заголовке ответа Token. Подходит для клиентских приложений.

Постраничный вывод​

Методы, возвращающие списки, принимают параметры page (номер страницы, с 0) и per_page (размер страницы: по умолчанию 60, максимум 200).

curl -H 'Authorization: Bearer <токен>' \
  'https://your-loop-server.ru/api/v4/users?page=0&per_page=200'

Ошибки​

При ошибке сервер возвращает HTTP-код ошибки и JSON:

{
  "id": "api.context.session_expired.app_error",
  "message": "Неверная или истекшая сессия, пожалуйста, войдите снова.",
  "detailed_error": "",
  "request_id": "hoan6o9ws7rp5xj7wu9rmysrte",
  "status_code": 401
}
  • id — постоянный идентификатор ошибки, по нему удобно обрабатывать ошибки в коде;
  • message — описание для пользователя на языке сервера;
  • request_id — идентификатор запроса, он же есть в журнале сервера.

Ограничение частоты запросов​

Системный администратор может включить ограничение частоты запросов (RateLimitSettings, по умолчанию выключено). Тогда в ответах появляются заголовки X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset, а при превышении лимита сервер отвечает кодом 429.

Разделы API​

Методы сгруппированы в меню слева:

  • Основное — пользователи, команды, каналы, сообщения, треды, файлы, реакции, поиск.
  • Интеграции — боты, вебхуки, slash-команды, интерактивные действия, OAuth, плагины.
  • Доступ и безопасность — аутентификация, роли, схемы разрешений, группы, LDAP, SAML.
  • Администрирование — настройки системы, задачи, импорт и экспорт, хранение данных, поиск Elasticsearch и Bleve.
  • Playbooks — сценарии и их запуски.