Справочник интеграций
Назначение
Справочник интеграций позволяет настроить обращение ЕРП к внешним REST-сервисам без программирования: описать API, его методы (эндпоинты), способ авторизации, параметры, тело и ответы запроса, а также поведение при обращении (таймауты, ограничение частоты, защита от сбоев). Настроенные интеграции затем вызываются из бизнес-процессов и dyn-кода.
Расположение: меню Интеграции.
Главный экран
На главном экране — список настроенных интеграций.
Возможности:
-
Поиск — поле сверху, фильтрует список по названию (поиск начинается автоматически).
-
Добавить интеграцию — кнопка/пустая карточка создаёт новую интеграцию и открывает её настройку.
-
Переключатель (тумблер у строки) — включает/выключает интеграцию. Выключенная интеграция сохраняется, но не выполняется.
-
Редактировать (карандаш) — открывает экран настройки.
-
Удалить (корзина) — удаляет интеграцию после подтверждения.
-
Пагинация — выбор числа строк на странице и переход по страницам внизу списка.
Настройка интеграции
Экран настройки разбит на вкладки: Основные, Авторизация, Расширенные, Методы.
Основные
Базовые поля интеграции:
-
Наименование — как интеграция отображается в списке.
-
Описание — назначение интеграции.
-
Базовый путь (basePath) — общий адрес сервиса, к которому добавляются пути методов.
Авторизация
Способ, которым ЕРП авторизуется во внешнем сервисе. Поддерживаемые типы:
-
Без авторизации — запросы уходят без авторизационных данных;
-
Basic — логин и пароль (HTTP Basic);
-
Token — токен в заголовке;
-
Bearer Token — токен в заголовке
Authorization: Bearer; -
JWT Bearer — JWT-токен;
-
API Key — ключ в заголовке или параметре.
| Набор полей меняется в зависимости от выбранного типа авторизации. |
Расширенные
Тонкая настройка выполнения запросов. Разделы:
-
Таймауты — предельное время соединения/чтения;
-
HTTP — параметры HTTP-клиента;
-
Воркер — параметры фонового выполнения;
-
SSL — настройки TLS;
-
Circuit Breaker — «предохранитель»: при серии ошибок сервиса обращения временно приостанавливаются, чтобы не нагружать недоступный сервис;
-
Rate Limiter — ограничение частоты запросов;
-
Логирование — уровень и объём логирования обращений.
| В разделе SSL можно отключить проверку сертификата. Делайте это только для доверенных внутренних сервисов с самоподписанным сертификатом — отключение проверки снижает защищённость соединения. |
Методы
Список методов (эндпоинтов) интеграции. Метод можно добавить, включить/выключить, отредактировать и удалить. Настройка метода разбита на вкладки: Основные, Параметры, Тело, Ответы, Тестирование.
-
Основные — название, HTTP-метод (GET/POST/…), путь метода (добавляется к базовому пути).
-
Параметры — параметры запроса: в строке пути (path), в query-строке (query) и в заголовках (header).
-
Тело — тело запроса (для POST/PUT и т.п.), см. «Конструктор схемы» ниже.
-
Ответы — ожидаемые ответы по HTTP-кодам, тоже описываются схемой.
-
Тестирование — пробный вызов метода прямо из справочника.
Конструктор схемы (Тело и Ответы)
Тело запроса и ответы описываются JSON-схемой. Есть два режима, переключаемых кнопками Конструктор / JSON:
-
Конструктор — визуальное дерево полей: у каждого поля задаётся тип (
string,number,integer,boolean,object,array), описание и значение по умолчанию; вложенные объекты и массивы добавляются как дочерние узлы. -
JSON — та же схема в виде текста JSON для быстрого редактирования/вставки.
Блок Preview внизу показывает итог в двух видах — Schema (упрощённое представление структуры) и JSON.
