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

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

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

Включите их в настройках роутов. Адреса ниже указаны относительно пути интерфейса API.

GET up

Базовая проверка доступности API и вызова метода контроллера. Можно передать произвольные параметры в строке запроса.

ПараметрЗначение
КонтроллерКласс UpIndex, метод list()
Обязательные параметрыНет
Успешный ответHTTP 200, JSON

Переданные значения возвращаются в поле parameters. Пример запроса

GET up/mcp

Проверяет состояние MCP-шлюза без запуска его JSON-RPC-контроллера. Нужны включённые API-интерфейс и сервисные роуты; сама проверка не кешируется и остаётся доступной для диагностики выключенного шлюза. Роут регистрируется, только если папка модуля native.mcp есть в local/modules или bitrix/modules. Без неё его нет в роутинге и документации, а запрос получает 404 как несуществующий роут.

Состояние MCPHTTPКод или результат
Папка модуля есть, модуль не установлен503MODULE_NOT_INSTALLED
Истёкшее демо или другая недоступность лицензии503MODULE_INACTIVE
Лицензия или демо-период действует, флаг шлюза выключен503MODULE_INACTIVE
Доступен и включён200Диагностический JSON UpIndex::mcp()

Это сервисный роут типа service. Запросы инструментов отправляются в POST /mcp; его тип и правила доступа отличаются.

GET up/user/{id}

Проверяет передачу параметра в адресе роута. Значение {id} попадает в parameters.id вместе с остальными параметрами запроса.

ПараметрЗначение
КонтроллерКласс UpIndex, метод list()
Параметр адресаid; отдельная проверка типа в карте не задана
Успешный ответHTTP 200, JSON

Пример запроса с ID и строкой запроса

GET up/group/{id}

Показывает настройку доступа по системной группе администраторов.

ПараметрЗначение
КонтроллерКласс UpIndex, метод list()
Параметр адресаid
Группа в whitelistAccessConfig::GROUP_CODE_ADMINISTRATOR
Ответ при текущей настройкеHTTP 403, GROUP_WHITELIST

Роут виден администраторам в документации. В его карте не задана авторизация API, поэтому запрос проверяется как анонимный и не проходит whitelist.

Пример проверки ограничения

POST up

Проверяет передачу тела запроса и вызов метода create(). Принятые параметры возвращаются в parameters.

ПараметрЗначение
КонтроллерКласс UpIndex, метод create()
Обязательные параметрыНет
Успешный ответHTTP 201, JSON

Пример передачи JSON

PUT up

Проверяет выполнение PHP-файла как контроллера и формирование XML-ответа.

ПараметрЗначение
КонтроллерPHP-файл UpScript.php
Обязательные параметрыНет
Успешный ответHTTP 200, XML
Технические ключиОтключены в карте
Корневой элементresponse, задан самим контроллером

Пример запроса и получения XML

DELETE up

Проверяет выполнение вызываемого класса через __invoke().

ПараметрЗначение
КонтроллерКласс UpInvoke, метод __invoke()
Обязательные параметрыНет
Успешный ответHTTP 200, JSON

Контроллер явно задаёт статус 200, поэтому диагностические данные передаются в теле ответа. Пример запроса

Данные ответа

Успешный вызов возвращает:

ПолеЗначение
methodHTTP-метод запроса
controllerКласс или путь PHP-контроллера
actionДействие контроллера
descriptionОписание роута из карты
parametersПолученные параметры запроса

Расположение данных зависит от технической обёртки. В PUT данные находятся внутри корневого элемента response.

Формат ответа можно изменить параметром format=json или format=xml в строке запроса.