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

Особенности версии

native.api продолжает развитие artamonov.rest, впервые опубликованного в 2018 году. В таблице — отличия от предыдущего модуля.

Что изменилось

Возможностьartamonov.restnative.api
Запуск APIДля работы с текущим пользователем требовалось самостоятельно подключать классы и модулиСервис подключает ядро Битрикса; пользователь доступен через контекст API
Клиенты пользователяОдин токен на пользователяНесколько клиентских сессий с отдельными парами токенов
Обновление доступаУправление одним токеном и его сроком действияПары access/refresh-токенов с раздельными сроками и ротацией
Отзыв доступаУдаление общего токена пользователяОтзыв выбранной клиентской сессии без отключения остальных
Хранение токеновИсходный токен в поле пользователяХеши токенов вместо исходных значений
Подготовка роутовКарты загружаются при обработке запросаСкомпилированные карты кешируются и используются повторно
Событийная модельРасширение логики через собственные контроллерыПользовательские обработчики до и после основных этапов запроса и операций с токенами
Пути API и документацииВыбор API по первому сегменту путиНезависимые вложенные пути API и документации с автоматическим обновлением точек входа
ДокументацияОписание роутов в админке и JSON-описание для клиентаOpenAPI и готовая интерактивная документация с выполнением запросов
Видимость документацииНастройки включения роута в административное и публичное описаниеДоступ к документации и набору роутов по группам пользователей
ЖурналированиеЖурналы запросов, ответов и лимитов в базеИстория с карточкой запроса; данные запросов и ответов в базе и файлах; аудит событий; независимая настройка записи
Рабочее пространствоАдминистративные страницы модуляДашборд с собственными и настраиваемыми гаджетами

Обновление до версии 2.2.0

При обновлении карты роутов и собственного PHP-кода:

  • замените ключ technical_keys_disabled на keys_technical_disabled, константу ResponseConfig::TECHNICAL_KEYS_DISABLED — на ResponseConfig::KEYS_TECHNICAL_DISABLED;
  • используйте OptionConfig::ROUTE_KEYS_TECHNICAL_DISABLED и метод isRouteKeysTechnicalDisabled() вместо прежних имён;
  • если флажок «Отключить технические ключи ответа» был включён, включите его заново на вкладке «Роуты»;
  • очистите кеш API-платформы.

Обновление до версии 2.0.0

Версия 2.0.0 добавила интеграцию отдельного native.mcp.

При обновлении собственного PHP-кода:

  • замените ApiException на Native\Api\Exceptions\ExceptionApi в импортах, типах и catch;
  • используйте ModuleApi::getName()/ModuleMcp::getName() вместо удалённой константы MODULE_NAME;
  • используйте текущие имена флагов и методов настроек, сохраняя строковые ключи опций;
  • для разных контекстов используйте псевдонимы ContextApi, ContextMcp и ContextBitrix, не переименовывая собственный класс Context;
  • секцию публикации роута как инструмента MCP описывайте константами ToolConfig вместо строковых ключей;
  • очистите кеш API-платформы после изменения карты или обновления её формата.

Обработчик controller — класс/метод, invokable-класс или PHP-скрипт. Анонимные controller в контракт версии не входят.