1. Создайте входную точку

Откройте «Подключения → REST API» и выберите «Приём данных в Data Bridge». Задайте название, версию API v1 и идентификатор, например orders. Идентификатор содержит 3–64 строчные латинские буквы, цифры или дефисы и должен быть уникальным среди точек этой версии в вашем разделе.

Выберите «Сразу после приёма» или «После обработки потоком». Во втором случае задайте время ожидания: более долгий запуск всё равно вернёт 202. Сделайте Idempotency-Key обязательным для защиты от повторной передачи заказов. Во вкладке «Лимиты API» переопределяйте только нужные настройки; без флажка действуют текущие общие значения.

Направления обмена данными через API
Направления обмена данными через API

2. Определите данные блока

Добавьте «Входные данные API» с этой точкой. Для таблиц выберите «Приём данных» и JSON, JSON Lines, CSV/TSV, XML или определение по Content-Type. JSON поддерживает массив объектов и путь вида data.items; вложенные объекты становятся полями a.b .

Введите небольшой тестовый набор и выберите его собственный формат. Нажмите «Обновить поля», проверьте предложенные типы и отметьте обязательные значения. Для заказа могут потребоваться orderId, числовое поле amount и дата в orderDate. Добавьте уникальный ключ orderId или нужное сочетание полей. Проверка формата проверяет, но не преобразует значения: нормализацию выполняйте отдельными блоками.

В справочнике блока «Входные данные API» описаны все свойства, поведение без доставки и правила тестовых данных.

3. Если запрос содержит файлы

В режиме «Приём файлов» настройте расширения, число файлов и правила чтения. Поддерживаются Excel XLSX/XLSM, CSV, TXT с разделителями, JSON и XML. Для Excel выберите лист и диапазон; для CSV — разделитель и заголовки; для JSON-файла — JSON Pointer, путь к данным. Строки всех файлов запроса образуют общую таблицу; при необходимости добавьте колонку имени файла.

Передавайте файлы как multipart/form-dataлибо один файл телом запроса с именем в X-File-Name или Content-Disposition. Для HMAC подписывайте фактически передаваемые байты тела. Тестовые данные служат просмотру и симуляции и никогда не подставляются в рабочий запрос.

4. Опубликуйте поток и отправьте запрос

Соедините источник с проверками и получателем, выполните симуляцию и опубликуйте Production. Дайте API-клиенту «Запись» этого потока; владельцу нужно право запуска. Скопируйте полный URL из формы. Ниже показана структура запроса: замените API_KEY, время и подпись по правилу подписи HMAC вашего клиента.

POST /api/v1/inbound/orders?p.Period=2026-10 HTTP/1.1
Host: databridge.example.com
Authorization: Bearer API_KEY
Content-Type: application/json
Idempotency-Key: orders-2026-10-28-batch-001
X-UBC-Timestamp: UNIX_SECONDS
X-UBC-Signature: v1=HMAC_HEX

[{"orderId":"ORD-1042","amount":1250,"orderDate":"2026-10-28"}]

Используйте p.Period только если такой параметр определён в потоке. Если точку используют несколько доступных потоков, укажите flow=identifier. Неизвестные параметры отклоняются.

5. Отслеживайте доставку и повторы

Сохраните идентификатор доставки и Location. Опрашивайте GET /api/v1/deliveries/{id} тем же клиентом; для подробностей запуска используйте возвращённую ссылку или GET /api/v1/runs/{run_id} . 202 означает приём, а не завершённую запись. HTTP 200 и статус доставки completed тоже не гарантируют бизнес-успеха: запуск мог завершиться со статусом failed, partial, uncertain или cancelled. Проверьте run.status, run.code, run.message и run.written, затем сверьте целевые данные. Статус доставки failed означает ошибку до создания запуска; причина указана в error, а исходный POST возвращает HTTP 409. Отдельный GET доставки или идемпотентный повтор могут вернуть HTTP 200 при разных текущих состояниях, поэтому всегда изучайте тело ответа.

Повтор одинакового тела с тем же ключом идемпотентности возвращает исходную доставку и Idempotent-Replayed: true. Другие данные или другой поток с этим ключом приводят к 409 IDEMPOTENCY_CONFLICT. Если подпись клиента включена, для повторного HTTP-запроса вычисляйте новый HMAC: одну подпись нельзя использовать дважды. Идемпотентность доставки не является общей транзакцией внешних записей.

6. Обратный вызов и диагностика

При необходимости задайте адрес обратного вызова и отдельный секрет не короче 32 символов. Data Bridge отправляет POST с JSON доставки, X-UBC-Delivery, событием delivery.completed или delivery.failed, временем и HMAC. Проверяйте время и сравнивайте подписи за постоянное время; повторные события обрабатывайте по идентификатору доставки. Событие delivery.completed означает завершение выполнения; его результат определяйте по run.status, коду, сообщению и числу записанного. Отсутствие ответа или ответ не-2xx запускает настроенные повторы с удвоением задержек; перенаправления не выполняются.

Намеренно проверьте неправильный тип и повтор уникального ключа: 422 API_INBOUND_INVALID возвращает причины в errors. Отсутствующая колонка может дать API_INBOUND_FIELDS; слишком большое тело — 413; заполненная очередь — 429 API_INBOUND_QUEUE_FULL. Данные доставки удаляются после завершения, а статус и отдельные записи аудита имеют собственный жизненный цикл. См. справочник точки и журнал запросов.