Схема работы

Для примера рассмотрим путь: https://{domain}/api/example/check

Общий принцип работы интерфейса следующий:

1. При входящем запросе веб-сервер пытается направить запрос по пути /api/example/check.
2. Когда веб-сервер понимает, что такого пути нет, он инициирует ошибку 404.
3. Когда срабатывает ошибка 404, то происходит запуск файла 404.php (указывается в настройках веб-сервера).
4. При запуске файла 404.php, учитывая, что в нем прописаны все директивы Битрикса, начинает отрабатывать файл init.php.
5. В случае, если файл init.php запускается успешно, то происходит запуск модуля.
6. При запуске, модуль анализирует настройки, правила и входящий запрос.
7. В случае, если для входящего запроса прописаны правила в карте роутов, тогда срабатывает контроллер указанный для роута.
8. В контроллере отрабатывает некоторая логика, которую пропишет разработчик.
9. В конце отработки метода контроллера необходимо вызвать функцию response()->json() для возврата результата клиенту.

Примечание

• Минимальная версия PHP >= 7.2 (согласно требованиям платформы). Использование более ранней версии возможно, но крайне не рекомендуется, ввиду возникновения ошибок.
• Обязательно наличие файла для обработки 404 ошибки (обычно имеется в корне сайта - 404.php) со всеми “директивами” 1С-Битрикса.
• Если используется веб-сервер Apache: обязательно прописать ErrorDocument 404 /404.php в .htaccess, расположенный в корне сайта, или прямо в конфигурационном файле Apache.
• Если используется веб-сервер Nginx: обязательно прописать error_page 404 = /404.php?$query_string; в секцию server конфигурационного файла (обычно nginx.conf).
• Для работы CORS-запросов необходимо чтобы на веб-сервере были разрешены запросы типа OPTIONS.