REST API

Что умеет решение

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

Студенты используют данный модуль для изучения принципов работы REST API и разработки собственных интерфейсов в рамках курсовых и дипломных проектов.

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

Модуль REST API предназначен для организации межплатформенного обмена данными. На основе опыта предыдущей версии разработана новая, оптимизированная версия ядра, обеспечивающая значительно более высокую скорость обработки запросов. В обновлении реализована карта роутов, позволяющая гибко настраивать параметры для каждого отдельного маршрута. Использование модуля сокращает время разработки интерфейсов API и снижает общие затраты на интеграцию. Поддержка осуществляется специалистами с опытом создания API-решений.

Модуль REST API от ВЕБКО • WEBCO предоставляет готовый интерфейс с библиотекой встроенных методов и возможностью разработки собственных кастомных методов для реализации любой логики. Система автоматически генерирует документацию, доступную для внешних разработчиков.

Модуль обеспечивает работу через нативный REST-провайдер 1С-Битрикс и загружается до запуска публичной части сайта без необходимости дополнительной настройки платформы. Интерфейс доступен по виртуальному пути, включая корень домена, поддомен или произвольный путь.

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

Функционал включает поддержку карт маршрутов и создание произвольных маршрутов с использованием переменных в пути. Для маршрутов можно устанавливать собственные контроллеры в виде классов, внешних классов или PHP-файлов. Доступ к маршрутам настраивается индивидуально, параметры входящих запросов проходят валидацию, а для конкретных маршрутов возможна авторизация по логину и паролю.

Модуль REST API от ВЕБКО • WEBCO предоставляет гибкие инструменты для управления доступом и обработки запросов. Поддерживается авторизация по токену на уровне отдельных роутов, генерация токенов для пользователей и проверка их групп при авторизации. Для конкретных роутов доступен список разрешенных логинов и токенов, а также возможность деактивации роута. Система позволяет ограничивать количество запросов в единицу времени для групп пользователей, передавать дополнительные заголовки в ответах, кэшировать входящие запросы и ответы средствами платформы, а также вести журнал запросов и ответов. Настройка CORS осуществляется через административную панель сайта. Для ускорения разработки интерфейса предусмотрены вспомогательные функции, библиотека встроенных роутов, а также примеры и руководства для разработчика. Полное описание возможностей, функций и примеров содержится в документации модуля.

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

Модуль REST API от ВЕБКО • WEBCO расширяет возможности стандартной реализации REST API в Битрикс, устраняя архитектурные недостатки и повышая производительность. В базовой версии при обработке запросов иногда выполняются лишние действия, создающие задержки; данный модуль оптимизирует этот процесс для максимальной скорости ответа.

Для повышения безопасности модуль позволяет задать уникальный маршрут доступа к API, скрывая стандартные пути, описанные в общедоступной документации. Это снижает риск атак. Можно настроить адрес доступа, используя поддомен, например api, или пути /rest, /api, /rest-api.

Кроме того, модуль добавляет функции управления, отсутствующие в базовой версии: настройку интерфейса через административную панель, контроль доступа к маршрутам, ограничение количества запросов от клиента и ведение журнала запросов и ответов.

1.7. В стандартном REST API 1С-Битрикс отсутствует возможность создания заказов через API. Данный модуль реализует недостающий функционал для выполнения таких операций.

1.8. Разработка и поддержка модуля осуществляются на основе запросов пользователей. При этом архитектура и развитие REST API 1С-Битрикс находятся под полным контролем разработчиков платформы. Характер этих изменений каждый пользователь оценивает самостоятельно.

Требования к среде:

- Минимальная версия PHP 8.1 или выше, что соответствует требованиям платформы. Использование более старых версий технически возможно, но крайне не рекомендуется из-за высокого риска возникновения ошибок.

- В корневой директории сайта должен присутствовать файл обработки ошибок 404 (обычно 404.php), содержащий все необходимые директивы 1С-Битрикс.

- Для веб-сервера Apache необходимо добавить директиву ErrorDocument 404 /404.php в файл .htaccess в корне сайта или в основной конфигурационный файл сервера.

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

- Для корректной работы CORS-запросов на веб-сервере должны быть разрешены запросы типа OPTIONS.

Модуль REST API разработан компанией ВЕБКО • WEBCO. При возникновении вопросов или предложений обратитесь в раздел поддержки, где указаны контактные данные. Партнёрам доступны индивидуальные условия скидок; для уточнения деталей свяжитесь с менеджером через раздел контактов.

General iT может взять на себя внедрение «REST API», включая установку, настройку и проверку результата.