Управление установками
Установка — это подключение конкретной интеграции внутри вашего портала. У каждой интеграции может быть только одна активная установка на портал.
Кто может управлять
Устанавливать, настраивать, включать, отключать и удалять интеграции могут администраторы портала или пользователи с соответствующим правом на раздел Интеграции.
Основные действия
| Действие | Что происходит |
|---|---|
| Посмотреть установки | открывается список активных и настроенных подключений текущего портала |
| Установить интеграцию | создаётся подключение со статусом Требуется настройка |
| Открыть карточку | показываются настройки, статус, возможности, последняя синхронизация и журнал |
| Сохранить настройки | обновляются только изменённые поля; секретные значения не показываются в открытом виде |
| Проверить соединение | система пробует подключиться к внешнему сервису с указанными параметрами |
| Включить | интеграция начинает работать в портале |
| Отключить | интеграция временно перестаёт выполнять свои действия |
| Удалить | подключение удаляется из портала; повторная установка возможна |
Публичные методы API
Для интеграторов доступны методы:
| Метод | Назначение |
|---|---|
GET /api/v1/integrations/installations | список установок текущего портала |
POST /api/v1/integrations/installations | установить интеграцию по её публичному идентификатору |
GET /api/v1/integrations/installations/:id | карточка установки |
PATCH /api/v1/integrations/installations/:id/config | обновить настройки установки |
POST /api/v1/integrations/installations/:id/enable | включить интеграцию |
POST /api/v1/integrations/installations/:id/disable | отключить интеграцию |
DELETE /api/v1/integrations/installations/:id | удалить интеграцию |
POST /api/v1/integrations/installations/:id/test | проверить соединение |
POST /api/v1/integrations/installations/:id/sync | запустить синхронизацию вручную, если интеграция поддерживает синхронизацию |
GET /api/v1/integrations/installations/:id/logs | журнал событий установки |
Настройки
В карточке установки отображаются только безопасные значения. Пароли, токены и API-ключи маскируются. Если при обновлении секретное поле оставить пустым, прежнее значение сохраняется.
После изменения настроек интеграция может вернуться в статус Требуется настройка до повторного включения или проверки соединения.
Журнал событий
Журнал показывает входящие и исходящие события, дату, направление обмена, результат и краткое описание ошибки, если она возникла. Полные секретные значения и чувствительные данные в журнале не отображаются.