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

Контекст API

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

Получение контекста

PHP
use Native\Api\Context;

$context = Context::getCurrent();

Данные запроса

МетодРезультат
getRequestId()Идентификатор запроса
getRequestMethod()HTTP-метод
isCli()true, если модуль выполняется через PHP CLI
getParams()Объединённые параметры адреса, строки запроса и тела
getRoute()Текущий роут; до его выбора — null
getAuth()Данные авторизации, включая User ID; без авторизации — null

Используйте getRequestId(), чтобы найти запрос в истории. Этот идентификатор связывает основную запись, входящие и исходящие данные и каталог файловых журналов. Метод getRequestStatus() возвращает PROCESSED или REJECTED: статус отражает прохождение проверки лимита.

Выполнение в CLI

$context->isCli() позволяет определить запуск через командную строку. В этом режиме обработчики onAfterResponse выполняются сразу после отправки ответа; их результат не меняет уже отправленный ответ.

Пользователь

После авторизации API контекст содержит ID пользователя Битрикса, от имени которого выполняется запрос:

PHP
$userId = $context->getAuth()?->getUserId();

Без авторизации $userId равен null. Права пользователя на запрашиваемые данные проверяет контроллер.

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

В контроллере полная конфигурация роута, включая пользовательские настройки, доступна через:

PHP
$config = $context->getRoute()
    ->getConfig()
    ->toArray();

IP-списки выбранного роута можно получить без чтения полного конфига:

PHP
$config = $context->getRoute()?->getConfig();
$whitelist = $config?->getSecurityIpWhitelist() ?? [];
$blacklist = $config?->getSecurityIpBlacklist() ?? [];

Назначение списков описано в безопасности роута.

События

В обработчики событий контекст передаётся в параметре apiContext. Метод setParams() позволяет изменить параметры запроса.

Внутреннее исполнение

В версии 2.0.0 Router::executeRoute($method, $path, $parameters, $routeHash) вызывает общий конвейер выбранного маршрута без HTTP-запроса сайта к себе. MCP использует его для инструментов. Хеш должен соответствовать декларации цели; совпадение фактического пути с другим статическим роутом не разрешает его исполнение вместо выбранного шаблона.

Во время внутреннего вызова Context::getCurrent() возвращает временный API-контекст с методом и аргументами цели, тем же REQUEST_ID и проверенным вызывающим пользователем. Явная схема авторизации цели и её права проверяются заново. После завершения восстанавливаются внешний Context и HttpResponse Битрикса, включая заголовки и cookies; исходный HTTP-запрос/IP не подменяется. getRequestMethod() здесь показывает метод цели, а не внешний POST MCP.

Native\Api\Context и Native\Mcp\Context остаются разными классами с собственным именем Context. При одновременном использовании применяют псевдонимы импорта:

PHP
use Bitrix\Main\Context as ContextBitrix;
use Native\Api\Context as ContextApi;
use Native\Mcp\Context as ContextMcp;