native.apiv1.1.0

Маршруты · доступ · интеграции

Свой API для сайта
и приложений

Разрабатывайте методы под задачи вашего проекта. Маршрутизацию, авторизацию, проверку параметров и OpenAPI берёт на себя native.api — модуль для 1С-Битрикс.

КупитьДокументация

14 дней демо · На вашем сервере · Развитие artamonov.rest

Как работает native.apiОт запроса до результата
  1. Запрос приложенияАдрес, HTTP-метод и параметры.
  2. Правила вашего APIМаршрут, авторизация, доступ и валидация.
  3. Ваша бизнес-логикаPHP-контроллер и ответ в JSON или XML.

Общая основа для ваших методов

Бизнес-логика — ваша.
Инфраструктура API — уже в модуле.

Не нужно заново собирать обработку запросов для каждой интеграции. Описывайте роуты и действия, а общие правила настраивайте в административном разделе Битрикса.

Маршруты и параметры

Свои адреса, HTTP-методы и контроллеры. Карта роутов задаёт обязательные параметры, типы и правила проверки вложенных структур.

Как устроены роуты

Клиентские сессии

Basic и Bearer, пары access/refresh-токенов. Подключайте несколько клиентов пользователя и отзывайте выбранную сессию отдельно от остальных.

Управление токенами

Правила доступа

Группы пользователей, IP-адреса, расписания, лимиты запросов и CORS. Общие настройки API можно уточнять для отдельных маршрутов.

Настройки доступа

Документация рядом с кодом

OpenAPI формируется из карты роутов. Команда изучает методы и выполняет запросы в Swagger UI. Видимость роутов настраивается по группам.

Интерактивная документация

Ответы и кеширование

Возвращайте JSON или XML. Настраивайте кеширование GET/HEAD и отдельных маршрутов. Проверки доступа сохраняются и при выдаче из кеша.

Формат ответа и кеш

История и диагностика

Дашборд, счётчики и карточки запросов помогают разбирать работу API. Запись запросов, ответов и событий включается в настройках модуля.

История запросов

Новое поколение API-платформы

Знакомая задача. Новая основа.

Продолжаем развитие нашего REST-модуля. Отдельные клиентские сессии, новые правила работы с токенами и интерактивная документация помогают развивать и сопровождать API.

Раньше · artamonov.restТеперь · native.api

Клиенты пользователя

Раньше
Один токен на пользователя
Теперь
Несколько клиентских сессий с отдельными парами токенов

Обновление доступа

Раньше
Общий токен и его срок действия
Теперь
Access / refresh, раздельные сроки и ротация

Отзыв доступа

Раньше
Удаление общего токена
Теперь
Отзыв выбранной сессии без отключения остальных

Хранение токенов

Раньше
Исходный токен в поле пользователя
Теперь
Хеши токенов вместо исходных значений

Подготовка роутов

Раньше
Загрузка карт при обработке запроса
Теперь
Повторное использование скомпилированных карт из кеша

Документация API

Раньше
Описание в админке и JSON для клиента
Теперь
OpenAPI и интерактивная документация с выполнением запросов
Все отличия в документации

От установки к своему API

Начните со встроенного запроса

Проверьте работу платформы на тестовом сайте: установите модуль, настройте API и выполните GET /up. Затем добавляйте методы для своих приложений и сервисов.

Демонстрационный период — 14 дней. Требования к окружению и порядок установки описаны в документации.

Инструкция по установкеПервый запрос
Первый запускТри шага до своих методов
  1. Установите модульЗагрузите его из Маркетплейса на тестовый сайт.
  2. Настройте и проверьтеЗадайте параметры API и выполните встроенный GET /up.
  3. Добавьте свои методыОпишите карту роутов и подключите контроллеры проекта.

Вопросы о native.api

Это готовый обмен с 1С, CRM или мобильным приложением?

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

Нужен ли разработчик для запуска?

Для установки и настройки нужен доступ администратора. Для создания прикладных методов нужен PHP-разработчик: он описывает карту роутов, пишет контроллеры и проверяет права на конкретные данные.

С какими платформами работает модуль?

PHP >= 8.2; 1С-Битрикс: Управление сайтом или Битрикс24 (коробочная версия). Перед установкой проверьте полные системные требования. В облачный Битрикс24 модуль не устанавливается.

Можно отключить один клиент, сохранив остальные?

Да. У пользователя может быть несколько клиентских сессий с отдельными парами токенов. Отзыв выбранной сессии не отключает остальные. Сроки действия и обновление доступа настраиваются средствами модуля.

Как перейти с artamonov.rest?

Сначала сравните возможности и проверьте свои карты, контроллеры и клиентов на тестовом сайте. У новой платформы изменились запуск API, контекст пользователя и работа с токенами. Совместимость прикладного кода нужно проверить перед переносом.

Можно попробовать перед покупкой?

Да, демонстрационный период — 14 дней. Начните с установки на тестовый сайт. Стоимость и условия покупки доступны в каталоге.

Следующая интеграция начинается здесь

Дайте проекту собственный API

КупитьДокументация