API-платформа
API-платформа — единая основа для ваших интеграций
Создавайте API для мобильных приложений, личных кабинетов, CRM, ERP и партнёрских сервисов на общей инфраструктуре.
Ваша команда реализует задачи бизнеса. Платформа предоставляет авторизацию, управление доступом, кеширование, документацию и журналирование.
Для проектов, в которых интеграции развиваются- Компаниям — для подключения внешних систем к сайту или корпоративному порталу.
- Командам разработки — для создания API мобильных приложений, личных кабинетов и внутренних сервисов.
- Интеграторам и студиям — как повторно используемая основа для клиентских проектов.
Решение работает в «1С-Битрикс: Управление сайтом» и коробочном Битрикс24.
От установки к своему API- Установите модуль штатным мастером Marketplace.
- Настройте адреса API и документации, включите сервисные методы и выполните проверочный запрос через Swagger.
- Добавьте прикладные методы и задайте правила доступа под задачи проекта.
| Для внедрения нужен разработчик. Методы работы с данными, обмены с конкретными системами и проверки прав на отдельные данные реализуются в вашем проекте. |
Что получает ваша команда
- Меньше повторной разработки. Используйте готовые механизмы авторизации, проверки параметров, формирования ответов и журналирования при подключении новых приложений и сервисов.
- Управляемый доступ. Разграничивайте операции по группам пользователей, настраивайте срок действия и ротацию токенов, отзывайте доступ отдельных клиентов.
- Контроль обращений. Ограничивайте запросы по IP-адресам, расписаниям и количеству. Настраивайте CORS для браузерных приложений.
- Удобное сопровождение. История входящих запросов, счётчики и настраиваемое журналирование помогают разбирать ошибки и отказы доступа.
- Документация вместе с API. OpenAPI-описание формируется из конфигурации маршрутов. Во встроенном Swagger можно изучать методы, параметры и ответы, а также выполнять запросы.
- Настраиваемое кеширование. Задавайте кеширование результатов отдельно для маршрутов. Проверки доступа сохраняются и при получении ответа из кеша.
При инциденте перегенерация ключа позволяет сделать все ранее выданные токены недействительными одной операцией.
Общая инфраструктура. Ваша бизнес-логика.Создавайте собственные маршруты и обработчики, используйте JSON и XML, расширяйте обработку запросов через события модуля.
Общая основа помогает сохранять единый подход к разработке и сокращать объём инфраструктурного кода, который команда поддерживает самостоятельно.
Настройки и токены доступны в административной части Битрикс, с раздельными правами на просмотр и изменение. Список операций Swagger учитывает групповые права пользователя — это удобно для внутренних команд и подрядчиков с разным уровнем доступа.
Изучите платформу до внедренияВ документации собраны:
- Установка и первый запуск.
- Настройка доступа и работа с токенами.
- Создание собственных маршрутов и обработчиков.
- Примеры запросов и расширения платформы.