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

Особенности платформы

Платформа предоставляет общие механизмы обработки запросов. Операции с данными сайта разрабатываются под задачи проекта. Полный перечень механизмов — в разделе «Возможности».

Настройка под проект

Разработчик задаёт адреса, HTTP-методы, параметры и правила доступа в карте роутов. Контроллеры выполняют действия, а события позволяют дополнить обработку запроса.

Формат ответа и описание API можно адаптировать к требованиям подключаемого приложения.

Ответственность интеграции

Модуль проверяет доступ к роуту и параметры согласно карте. Контроллер должен отдельно проверять права пользователя на конкретные записи, например заказ или документ, и выполнять бизнес-правила проекта.

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

Собственные доработки

Храните карту и контроллеры вне каталога модуля. Для замены интерфейса документации используйте переопределение через local.

После изменения карты очистите кеш модуля. После обновления проверьте используемые сценарии интеграции.