1. Создайте подключение к ресурсу
В «Подключения → REST API» выберите «Обращение к внешнему API». Задайте понятное название, базовый HTTPS-адрес сервиса и относительный путь ресурса, например /orders. Одно подключение описывает ресурс и метод запроса. Для другого ресурса или метода создайте отдельное подключение, чтобы назначение и права каждой интеграции оставались явными.
Не добавляйте строку запроса после вопросительного знака в пути. Базовые параметры вводите по одному name=value в строке; блок-источник может добавлять свои параметры. Дополнительные заголовки задавайте как Name: value. Секреты, включая Authorization, относятся к специальным полям аутентификации, а не обычным заголовкам.
2. Настройте аутентификацию и сеть
Выберите способ, поддерживаемый внешним сервисом: без аутентификации, Basic, Bearer, ключ API в заголовке или OAuth2 client credentials. Для Basic нужны имя и пароль; для ключа API — имя заголовка и ключ; для OAuth2 — адрес токена, Client ID, секрет клиента и нужная область доступа. Ключ входного API Data Bridge не заменяет реквизиты внешнего сервиса.
Проверьте DNS, порт, доверие к TLS-сертификату и права учётной записи. Для внутреннего ресурса используйте согласованный сетевой маршрут или настроенный UBC Agent. «Тест» проверяет доступность; успех не гарантирует права на чтение всех ресурсов или запись. Изучите диагностику и сохраните подключение.
3. Прочитайте и разберите ответ
Для источника используйте GET или POST. Чтение POST имеет собственное тело запроса выбранного формата; это отличается от получателя, отправляющего строки таблицы. Явно задайте формат ответа или определяйте его по Content-Type: JSON, XML, CSV/TSV или JSON Lines. Проверьте кодировку, разделитель и заголовки.
В ответе ниже путь записей — data.items. Для XML нужен путь элементов, например ./item; при необходимости можно включить атрибуты родителей. Вложенные объекты становятся колонками с точками в имени. Добавьте подключение как источник и просмотрите поля до настройки фильтра или сопоставления.
{"data":{"items":[{"orderId":"ORD-1042","status":"open","amount":1250}]}}4. Настройте полное чтение страниц
Следуйте правилам сервиса: один ответ, следующая ссылка в JSON/XML, заголовок Link , номер страницы или смещение. Для номера задайте имя параметра, первую страницу и размер; для смещения — параметр смещения и размер порции. Для ссылки в теле укажите точный путь; она должна вести на тот же сервер.
Ограничьте число страниц и размер таблицы ответа. Например, сервис с параметрами page и page_sizeнельзя читать по смещению, даже если первая страница выглядит правильно. Проверьте не менее двух страниц, последнюю неполную страницу и отсутствие повторов ключей. Ссылки из тела не применяются к CSV и JSON Lines.
5. Отправьте строки через получателя
Для записи выберите POST, PUT или PATCH и формат JSON, XML, формы или CSV. Получатель создаёт тело из входной таблицы. JSON передаёт объект строки или массив объектов; при необходимости задайте ключ массива порции. XML требует элемент строки и корень порции. Данные формы поддерживают только отдельный запрос на строку. CSV включает заголовки и значения.
Отдельные запросы могут использовать путь вида /orders/{{orderId}}. Задайте размер порции по правилам API, подготовьте небольшой тест и проверьте получателя по ключу. Смысл PUT и PATCH определяет внешний сервис: не предполагайте автоматический upsert или идемпотентность, если это не предусмотрено его контрактом.
6. Проверьте ошибки и журнал
В «Настройки → API → Лимиты API» администратор управляет повторами, задержками, Retry-After и защитным отключением запросов после серии сбоев. Временные ошибки чтения могут повторяться; запись повторяется только если точно не была принята, например при сбое до установления соединения или HTTP 429. Потерянный ответ записи остаётся неопределённым: сначала сверьте получателя.
В контекстном меню блока откройте «Запросы API», чтобы проверить метод, адрес, статус и длительность. Проверьте 401/403, пустые ответы, изменения схемы и лимиты страниц. Сравните журнал с результатом блока и итоговым числом записей. Для управляемого приёма внешних запросов предназначено другое направление — входная точка API.