Модуль Awelite: REST API поможет быстро настроить интерфейс Rest Api для быстрой интеграции сайтов и интернет-магазинов на 1С-Битрикс: Управление сайтом со сторонними системами – мобильным приложением, 1С, и другими через HTTP-запросы в формате JSON.
Модуль дополняет технологию REST API Bitrix инструментами для тонкой настройки и масштабирования интеграции.

Авторизация и регистрация
После установки модуля, становится доступна регистрация и авторизация пользователя на сервере из стороннего приложения, а также обновление токенов доступа при истечении времени жизни токена.
Функционал авторизации адаптирован для REST API. Интегрируемая система после авторизации пользователя может поддерживать авторизацию и обмениваться с сервером необходимыми данными путем путём HTTP-запросов. Безопасность соединения достигается путем использования технологии JWT токенов доступа JSON Web Token(JWT) с возможностью использовать свой секретный ключ шифрования.

Роуты и мидлвары
В настройках модуля удобно просматривать все настроенные роуты на вкладке Карта Роутов.
После установки модуля сразу доступна структура файлов с примерами для разработки своих роутов и милдваров.
Функционал модуля предусматривает обработку исключений, которые отправляются пользователю без вызова контроллера.

Пример использования
При разработке мобильного приложения интернет-магазина требуется получать данные с сервера веб-версии интернет-магазина на 1С-Битрикс: Управление сайтом.

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

Примеры роутов(маршрутов) с пояснениями:

Пример 1.
$route->group([‘prefix’ => ‘/catalog’, ‘middleware’ => ‘auth’], function (Route $route) {
$route->get(‘/products’, ProductController::class)
->name(‘catalog.store’)
});

По маршруту /catalog/products присваиваются имя catalog.store, тогда этот маршрут становится доступным по GET запросу.
Сначала запускается middleware auth (алиас миддлавара \Awelite\RestApi\Middlewares\AuthMiddleware::class), следом контроллер ProductController в методе __invoke(), которые необходимо создать и подключить на сайте дополнительно.

Пример 2.
$route->get(‘/fr’, [\Awelite\RestApi\Controllers\AddController::class, ‘gf’])->name(‘Новый’);
Вызовет контроллер \Awelite\RestApi\Controllers\AddController с методом ‘gf’ по маршруту /fr.