Роуты

Вкладка «Роуты» находится в разделе «Сервисы → API-платформа → Настройки модуля». Здесь включаются встроенные роуты и задаются общие параметры кеширования и ответа.

Активация роутов

Три группы роутов включаются независимо. Отключённые группы исключаются из карты и встроенной документации. Включение сохраняет требования авторизации и ограничения доступа.

Нативные роуты

Включает встроенные операции с токенами: выпуск, обновление, просмотр сессий и отзыв клиента. Используйте этот параметр, если подключённые приложения управляют токенами через API.

Работа с ними описывается в разделе «Токены авторизации». Отключение этих роутов само по себе не отзывает уже выпущенные токены.

Сервисные роуты

Включает роуты для проверки работы интерфейса, в том числе GET /up. Они помогают проверить обработку запросов без создания собственных контроллеров.

После включения проверьте доступные операции через «Документацию». Если сервисные роуты больше не нужны, отключите их для дополнительной безопасности: это закроет доступ к диагностическим операциям и сведениям о выполнении запросов.

Роут-провайдер

Включает операции GET /provider и POST /provider: просмотр описания разрешённых методов и их выполнение через API. Для обращения требуется access-токен.

Доступны только классы и методы, разрешённые провайдером; явные запреты имеют приоритет. Само включение флажка не открывает доступ ко всем методам платформы.

Настройки роутов

Время кеширования

Срок хранения результата контроллера в секундах. Общее значение применяется к GET- и HEAD-роутам, если для них не задано собственное правило кеширования.

Например, 300 означает 5 минут, а 86400 — 24 часа. Число 86400 в подсказке пустого поля не применяется автоматически. Кеш карты роутов работает независимо от этого поля.

Приоритет настроек

В карте роута задан ttl?
├─ Да
│  ├─ ttl > 0 → кешировать на этот срок
│  └─ ttl = 0 → не кешировать
│
└─ Нет
   ├─ GET или HEAD → взять общее значение
   └─ Другой метод → не кешировать

Индивидуальный срок действует для любого HTTP-метода, включая POST. При попадании в кеш контроллер не выполняется, но доступ и параметры проверяются. Пример настройки и порядок обработки. Для действий, которые должны выполняться при каждом запросе, отключите кеширование.

Технические поля

По умолчанию модуль добавляет к ответу служебные поля request_id, status и time. Непустой результат контроллера помещается в result.

Включённый флажок убирает эту обёртку из успешных ответов: JSON, XML. В JSON данные контроллера становятся корневой структурой; в XML также убирается внешний элемент response. Это позволяет формировать ответ под требования подключаемой системы.

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

Поведение можно переопределить для отдельного роута в его карте. Индивидуальная настройка имеет приоритет над флажком на этой вкладке.