Документация1С-Битрикс: Модулиnative.apiОбзор модуля

Возможности

Роуты и параметры

Статические адреса и адреса с переменными, собственные контроллеры и действия. Многоуровневая валидация входящих параметров по карте роутов: обязательность, типы, допустимые значения и вложенные структуры, включая элементы списков.

Авторизация и доступ

Basic- и Bearer-авторизация, выпуск и обновление токенов доступа, настройка сроков их действия и отзыв клиентских сессий.

IP-ограничения для всего API и отдельных роутов, ограничения по группам пользователей, расписания доступности, лимитирование запросов и настройка CORS для обращений из браузера.

Ответы и кеширование

Форматы JSON и XML. Общее кеширование задаётся в настройках модуля для GET/HEAD. Настройки кеширования отдельного роута имеют приоритет над общими.

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

Генерация OpenAPI из карт роутов и рендер документации для просмотра и выполнения запросов. Доступ к странице документации и видимость роутов настраиваются по группам пользователей.

Дашборд и мониторинг

Дашборд, счётчики запросов по HTTP-методам, техническая история входящих запросов со статусами для расчёта лимитов, карточка запроса с параметрами, заголовками и ответом. Входящие и исходящие данные можно независимо сохранять в базу и файлы при включённом сборе запросов. Также доступны журнал событий и файловые логи. Дашборд поддерживает собственные гаджеты.

Событийная модель

Обработчики событий до и после этапов запроса и операций с токенами.