Дашборд
Дашборд находится в разделе «Сервисы → API-платформа → Дашборд». Он показывает состояние модуля, параметры авторизации и логирования, состав роутов и накопленную статистику запросов. Чтобы получить актуальные значения, обновите страницу.
Для просмотра и персональной настройки требуется право чтения раздела «Рабочий стол» на вкладке «Доступ».
Гаджеты
В поставку входят пять гаджетов. По умолчанию они размещены в двух столбцах: «Запросы» — под «Маршрутами» слева, «Логирование» — под «Авторизацией» справа.
Настройки
Сводка текущих настроек и окружения сайта. Помогает проверить, включён ли API и какие пути используются.
| Показатель | Что показывает |
|---|---|
| API-интерфейс | Активен ли API-интерфейс модуля |
| Путь интерфейса и Путь документации | Адреса API и встроенной документации |
| Путь карты маршрутов | Путь пользовательской карты роутов |
| Путь к журналам | Каталог для файловых журналов |
| Нативные роуты, Сервисные роуты, Роут-провайдер | Какие наборы роутов включены |
| Версия PHP | Версия PHP, под которой открыта страница дашборда |
Для незаполненного пути выводится прочерк. Изменить пути можно на вкладке «Основные», а наборы роутов — на вкладке «Роуты».
Авторизация
Показывает способы авторизации в загруженной карте роутов, сроки жизни токенов и наличие лимитов запросов.
| Показатель | Что показывает |
|---|---|
| Авторизация по логину и паролю | Есть ли в карте роут с этим способом авторизации |
| Авторизация по токену | Есть ли в карте роут с авторизацией по токену |
| Срок жизни access-токена и Срок жизни refresh-токена | Настроенные сроки в секундах |
| Ограничение запросов | Задан ли положительный лимит количества запросов в общем правиле или хотя бы для одной группы |
| Выдано токен-пар | Количество сохранённых access-токенов, каждый из которых представляет токен-пару |
Наличие способа авторизации определяется и по отключённым в карте роутам. Статус «Активно» не означает, что авторизация обязательна для всех запросов.
«Выдано токен-пар» — текущее количество сохранённых пар, а не число выдач за всё время. Истёкшие пары учитываются, пока их записи не удалены. При наличии права чтения токенов авторизации число становится ссылкой на их список.
Сроки жизни токенов и лимиты задаются на вкладке «Безопасность».
Маршруты
Показывает количество роутов по HTTP-методам и отдельные счётчики их ограничений:
- отключённые роуты;
- роуты с авторизацией по логину или по токену;
- роуты с белым или чёрным списком групп пользователей.
Учитывается объединённая карта: встроенные и пользовательские роуты с учётом включённых наборов
на вкладке «Роуты».
Отключённые наборы исключаются, но отдельный роут с active: false остаётся в подсчёте своего HTTP-метода
и дополнительно попадает в число отключённых.
Один роут может учитываться в нескольких показателях — например, требовать токен и иметь белый список групп. Поэтому складывать все строки гаджета для получения общего числа роутов не нужно.
Запросы
Показывает общее количество учтённых обращений и распределение по HTTP-методам:
GET, POST, PUT, PATCH, DELETE, OPTIONS и HEAD.
Подсчёт включается на вкладке «Аналитика» отдельно для каждого метода. Учитываются обращения к обработчику API, в том числе отказы, ошибки и ответы из кеша. Значения накопительные, без разбивки по дням.
Отключение сбора сохраняет прежние значения. Для начала подсчёта заново используйте «Очистить статистику» на вкладке «Аналитика». Счётчики не зависят от истории входящих запросов, используемой для лимитирования.
Логирование
Показывает параметры вкладки «Логирование» по алфавиту названий. Для каждой строки отдельно указаны два направления:
- «Журнал» — запись событий в системный журнал Битрикса, а входящих и исходящих данных — для просмотра в карточке запроса.
- «Логи» — запись в файлы.
Каждый флаг отображается как «Активно» (зелёный) или «Отключено» (красный). Гаджет показывает настройки, но не проверяет успешность записи. Для сохранения входящих и исходящих данных дополнительно включите сбор входящих запросов.
После обновления сохранённая раскладка рабочего стола не меняется автоматически. Если гаджета нет, добавьте его через «Добавить гаджет» после установки файлов обновления.
Рабочий стол
Состав и расположение
Кнопка «Добавить гаджет» открывает список доступных гаджетов. Перетаскивайте их за заголовок между столбцами и меняйте порядок. Через «Настроить» в заголовке гаджета можно изменить его название, через «Удалить» — убрать с рабочего стола. Удаление гаджета не удаляет данные модуля; его можно добавить снова.
В меню «Настройки → Настроить рабочий стол» задаются число столбцов от 1 до 9 и ширина каждого в пикселях или процентах. Состав, расположение и настройки гаджетов сохраняются для текущего пользователя.
Настройки по умолчанию
«Настройки → Сбросить текущие настройки» возвращает ваш рабочий стол к настройкам по умолчанию. Настройки API и накопленные данные при этом сохраняются.
Администратору также доступно действие «Сохранить как настройки по умолчанию». Оно задаёт начальное оформление для пользователей, которые ещё не настраивали свой рабочий стол. Уже сохранённые персональные настройки других пользователей сохраняются.
Собственные гаджеты
Дашборд поддерживает добавление собственных гаджетов и перекрытие штатных через local/gadgets/native.api/.
Гаджет с новым именем каталога дополняет список, с именем штатного — заменяет его.
После добавления разработчиком гаджет можно выбрать через «Добавить гаджет».
Так на рабочий стол можно вывести показатели и сведения, нужные вашему проекту.