Оформление
Выбрать способ интеграции
Сначала определите, кто инициирует обмен и нужно ли ждать ответа. Это помогает выбрать понятную схему без лишних компонентов.
| Задача | Способ |
|---|---|
| Внешняя программа читает или изменяет записи | HTTP API |
| Другая система отправляет JSON с собственными названиями полей | Входящее подключение |
| Нужно сообщать внешней системе о событиях | Исходящий webhook |
| Нужно загрузить подготовленный CSV/JSON | Импорт |
| Нужно получить ограниченную выгрузку | Экспорт |
Где находится
Настройки платформы → Настройка системы → Интеграции. Для входа в экран платформы нужна возможность Superuser, но одной надписи роли недостаточно: сервер отдельно проверяет право управления интеграциями (integration.manage), а для исходящих webhook — webhook.manage. При «Недостаточно прав» проверьте соответствующее служебное действие через диагностику доступа, не создавайте ключ в обход отказа.
Права API-ключа и его владельца проверяются отдельно — доступ к настройкам не означает неограниченный доступ внешней программы. Также не следует считать право управления интеграциями само по себе доступом к любым данным заявок.
Вкладки раздела
| Вкладка | Для чего нужна |
|---|---|
| Приём данных | Создать, изменить, открыть, включить или архивировать входящее подключение; проверить его историю |
| Доступ по API | Понять прямые вызовы API без webhook, перейти к выдаче ключа и примерам |
| Отправка событий | Настроить исходящий webhook и проверить доставки |
| Ключи доступа | Выдать отдельный ключ с ограниченными действиями и сроком; отозвать ненужный |
| Загрузка файлов | Настроить и проверить файловый импорт |
| Архив | Найти отключённые подключения и восстановить настройку; восстановление не включает обмен автоматически |
| Инструкция | Открыть встроенные адреса методов, примеры и пояснения |
Фильтры и поиск списка помогают найти настройку, но не меняют её состояние. Перед архивированием проверьте, какая внешняя программа использует подключение.
Как начать безопасно
- Выберите тестовую среду и одну учебную запись.
- Опишите поля и ожидаемый результат.
- Выдайте отдельный ключ с минимальными действиями или настройте отдельный секрет подписи webhook.
- Проверьте успешный запрос, отказ в доступе, неверные данные и повтор после сетевого сбоя.
- Только после этого включайте реальную обработку.
Входящий HTTP-запрос и исходящий webhook используют разные секреты. Не передавайте API-ключ NGENSIA получателю webhook.
Подключение и готовая доставка — разные вещи
Сохранённые настройки не доказывают, что удалённый сервер доступен, подпись проверяется, а фоновые обработчики запущены. Проверяйте результат обмена и журнал доставок.