REST API

Поблагодарить: https://donate.artamonov.pro

Модуль помогает организовать программный интерфейс для внешних и внутренних приложений.

Ранее нами уже был разработан и опубликован на бесплатной основе модуль REST API. Данный модуль хорошо себя зарекомендовал для решения задач межплатформенных обменов, показателями этого факта являются отзывы и количество скачиваний. Со временем стало появляться множество запросов по доработке модуля, и как следствие, мы приняли решение о написании новой, усовершенствованной версии уже полюбившегося модуля.

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

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

Что получите от приобретения модуля:

- Уменьшение стоимости разработки API за счет сокращения времени на программирование интерфейса.

- Поддержка от профессионалов, имеющих большой опыт создания API.

- Готовый RESTful API интерфейс, с библиотекой встроенных методов, а также с возможностью создавать собственные, кастомные методы, реализующие любую, необходимую логику. И конечно, с автогенерируемой документацией, которую можно предоставить сторонним разработчикам.

Возможности:

- Использование API 1С-Битрикс через нативный рест-провайдер.

- Загрузка интерфейса до запуска публичной части сайта.

- Отсутствие необходимости в дополнительной настройке платформы.

- Виртуальный путь к интерфейсу, в том числе и от корня домена (https://domain.com/ или https://domain.com/{api}/ или https://api.domain.com/).

- Настройка доступа в административной части сайта к разделам модуля на уровне групп пользователей.

- Автогенерируемая документация в административном разделе.

- Автогенерируемая документация для клиента в JSON-формате.

- Поддержка карт роутов.

- Создание произвольных роутов (/{api}/user/, /{api}/user/get/, /{api}/user/v1/, ... ).

- Установка собственных контроллеров для роутов (классы, внешние классы, php-файлы).

- Настройка уровня доступа к роутам.

- Валидация параметров входящего запроса.

- Авторизация по логину и паролю для конкретного роута.

- Авторизация по токену для конкретного роута.

- Генерация токенов для пользователей.

- Поддержка списка "белых" логинов/токенов для конкретного роута.

- Проверка групп пользователя при авторизации для конкретного роута.

- Возможность ограничения количества запросов в единицу времени на уровне групп пользователей.

- Возможность передачи дополнительных заголовков при ответе.

- Возможность деактивировать конкретный роут.

- Кэширование входящих запросов и ответов средствами платформы.

- Журналирование запросов и ответов.

- Настройка CORS из административной части сайта.

- Наличие функций упрощающих разработку интерфейса.

- Наличие библиотеки встроенных роутов ускоряющих разработку интерфейса.

- Наличие примеров и руководств для разработчика.

Более подробно все возможности, функции и примеры описаны в документации, которая имеется в модуле.

FAQ:

Чем данный модуль отличается от REST API Битрикса?

1.1. В REST API Битрикса мало гибкости, есть необходимость использовать именно предоставленные роуты. Данный модуль позволяет формировать свои роуты, писать свою логику при обработке запроса, то есть предоставляет больше гибкости;

1.2. REST API Битрикса реализовано не совсем согласно архитектурному стилю REST;

1.3. В REST API Битрикса, при обработке запроса порой происходят «лишние» действия, которые могут создавать дополнительную задержку при ответе клиенту, может это и не сильно критично, но API должно быть настолько быстрым, насколько это возможно;

1.4. API не всегда должно быть доступно всем, иногда оно должно быть уникально (роуты, параметры, ... ) для проекта, но за счет общего стиля REST API Битрикса, документация которого в общем доступе, эта уникальность нарушается и создает дополнительную лайзеку для атак на сайт. Используя данный модуль, можно указывать собственное имя роута, где будет работать API. Например: domain.com/rest/ или domain.com/api/, или domain.com/rest-api/, или api.domain.com, и так далее;

1.5. В REST API Битрикса нет возможности как-то управлять интерфейсом из административной части сайта;

1.6. В REST API Битрикса нет возможности регулировать доступы к роутам, ограничивать доступ по количеству запросов от клиента, журналировать запросы и ответы, и некоторые другие функции.

1.7. На текущий момент, в REST API Битрикса, например, нет возможности создать заказ через API. Используя данный модуль вы можете реализовать этот функционал.

1.8 В целом, данный модуль пишется и развивается на основе запросов пользователей, но REST API Битрикса пишется на усмотрение Битрикса. Плюс это или минус - решать вам.

Примечание:

- Минимальная версия PHP >= 8.0 (согласно требованиям платформы). Использование более ранней версии возможно, но крайне не рекомендуется, в виду возникновения ошибок.

- Обязательно наличие файла для обработки 404 ошибки (обычно имеется в корне сайта - 404.php) со всеми "директивами" 1С-Битрикса.

- Если используется веб-сервер Apache: обязательно прописать ErrorDocument 404 /404.php в .htaccess, расположенный в корне сайта, или прямо в конфигурационном файле Apache.

- Если используется веб-сервер Nginx: обязательно прописать error_page 404 = /404.php?$query_string; в секцию server конфигурационного файла (обычно nginx.conf).

- Для работы CORS-запросов необходимо чтобы на веб-сервере были разрешены запросы типа OPTIONS.

Спасибо Вам за ознакомление с нашим модулем. Если у Вас имеются какие-либо вопросы/предложения, то мы всегда готовы обсудить их через контакты, указанные в разделе поддержки.