Настройте обмен данными между системами
API позволяет приложениям автоматически обмениваться данными. Принимайте заказы, проверяйте по своим правилам и передавайте результаты другим системам. Вы выбираете данные, формат ответа и правила доступа.
Принять · Подготовить · Предоставить
Единый управляемый маршрут приёма, проверки, преобразования и передачи данных
Собственные адреса с полями, параметрами и актуальностью, нужными потребителям
Готовая документация, понятные ответы и отдельные настройки доступа для каждого потребителя
Пусть отправитель увидит ошибку. До записи данных.
Определите схему, обязательные значения и уникальный ключ. Выбранная политика обработки ошибок определяет, что произойдёт с некорректным запросом.
/api/v1/inbound/orders[
{
"orderId": "ORD-1042",
"amount": "abc",
"orderDate": "2026-10-28"
}
]Поле нужно исправить
В первой строке поле amount содержит текст вместо числа. Подробный ответ указывает поле, строку и причину ошибки.
code: API_INBOUND_INVALIDПри этой политике некорректный запрос не запускает поток.Документация, которая соответствует вашей настройке.
Методы, поля, правила доступа, примеры и ответы — в одном справочнике для интегратора.
Принимайте данные других систем
Заказы портала, обновления остатков филиалов и файлы партнёров могут сразу поступать в согласованный поток. Создайте подключение REST API с направлением «Принимать данные в Data Bridge», задайте версию и адрес, затем добавьте блок входных данных API. После публикации каждая принятая доставка запускает поток Production. Тело запроса поддерживает JSON, JSON Lines, CSV/TSV и XML; файловый режим читает Excel XLSX/XLSM, CSV, TXT с разделителями, JSON и XML. Настройте путь записей, лист, диапазон или разделитель источника. Партнёры передают привычные форматы, а ваша команда управляет обработкой.
- Приём таблицы в теле запроса или файлов через multipart/form-data
- Объединение строк файлов одного запроса в таблицу обработки
- Версии адреса API и выполнение опубликованной логики потока
Проверяйте данные сразу при получении
Предоставьте пример данных для создания полей и предлагаемых типов. Проверьте текстовые, целочисленные, дробные, календарные, временные и логические поля; отметьте обязательные значения и простые или составные уникальные ключи. Например, номер заказа вместе с номером строки не должен повторяться в одной доставке. Такая проверка контролирует соответствие без автоматического изменения значений. Затем «Сопоставление столбцов» задаёт названия, выбор и порядок полей; соединения со справочниками дополняют записи; «Очистка и контроль данных» применяет правила по порядку. Пустая сумма может стать числовым нулём, отрицательная — остановить обработку с DATA_QUALITY. Нормализация, отклонение строк и остановка — явные решения под ваш процесс.
- Входные проверки форматов, обязательных значений и повторных ключей внутри запроса
- Сопоставление, справочники, формулы и правила качества перед записью
- Предпросмотр и симуляция с тестовыми данными, которые никогда не подставляются в рабочие доставки
Определите правила обмена
Уточните отправителей, потребителей, нужные поля, критерии успеха и требования к актуальности.
Постройте и проверьте поток
Настройте схему, сопоставление и правила качества. Проверьте корректные и ошибочные примеры в симуляции.
Предоставьте нужный доступ
Назначьте права, ограничения и ключ клиента или осознанно включите публичную публикацию.
Опубликуйте и подключите потребителя
Предоставьте доступ к документации, проверьте Production, протестируйте доставку или чтение и наблюдайте за аудитом.
Объясняйте, что нужно исправить
Некорректные входные значения могут вернуть HTTP 422 API_INBOUND_INVALID со строкой, столбцом, полем, значением, типом ошибки и причиной; подробности повторного ключа указывают поля и исходную строку. Выберите полный отказ с деталями, краткую сводку или приём только корректных строк. Ответы содержат до 100 ошибок и общие количества. Асинхронный HTTP 202 возвращает идентификатор доставки и Location для отслеживания. Режим ожидания завершения возвращает конечный результат или 202 по истечении ожидания. Проверяйте run.status, run.code, run.message и количества записей: HTTP 200 и delivery.completed сами по себе не гарантируют успех потока. Невозможность создать запуск отличается от ошибки бизнес-правила во время выполнения.
- Отсутствующие столбцы — API_INBOUND_FIELDS; неверные значения — API_INBOUND_INVALID
- Ошибки проверки потока, например DATA_QUALITY, появляются в run.code и run.message
- Подписанные обратные вызовы сообщают о завершении доставки; результат вложенного запуска проверяется отдельно
Читайте и отправляйте данные через API
Data Bridge может обращаться к внешнему сервису или передавать ему результат потока. Прочитайте заказы системы продаж, дополните кодами учётной системы и передайте согласованный пакет финансам. Чтение поддерживает GET или POST, разбор ответа и страницы по ссылкам next, заголовкам Link, номерам или смещениям. Отправка поддерживает POST, PUT или PATCH, отдельный запрос для строки или пакеты. Выберите JSON, XML, данные формы или CSV по контракту получателя. Внешняя аутентификация использует учётные данные сервиса: Basic, Bearer, ключ API в заголовке или OAuth 2.0 client credentials. Открытый сервис доступен без аутентификации.
- Настройка путей, параметров, заголовков, формата и пакетов получателя
- Сопоставление исходящей структуры вместо ручной перестановки полей
- Доступ к разрешённым внутренним API через настроенный UBC Agent
Принять · Подготовить · Предоставить
Делитесь данными, нужными каждому приложению
Порталу нужны остатки по складам, приложению — курсы на дату, партнёру — доступный ассортимент. Объедините источники, примените правила и подключите результат к публикации данных API. Потребители получают согласованные поля в JSON, JSON Lines, CSV или XML. Настройте текстовые, числовые или календарные параметры: отдельные значения, списки, диапазоны, допустимые границы и обязательный ввод. Адрес может выдавать сохранённый результат с проверкой возраста или выполнять поток по запросу. Длительные расчёты возвращают 202 API_RUN_PENDING и адрес next, продолжающий ожидание того же запуска. Завершённый результат можно повторно использовать в течение заданного срока.
- Фильтрация подготовленных строк или передача значений в параметры запуска
- Чтение согласованных страниц результата; ETag и 304 для неизменившихся данных
- Неудачный запуск по запросу — 502 API_RUN_FAILED; устаревшие сохранённые данные — API_DATA_STALE
Дайте разработчикам готовую справку
Техническая HTML-документация формируется из сохранённых настроек адреса, конфигурации блоков и примера данных. Она описывает полный адрес, формат, поля, обязательные значения, уникальные ключи, параметры, ответы, ошибки и действующие ограничения. Краткая инструкция и примеры curl, Postman и Python помогают повторить первый запрос; при необходимости включаются примеры HMAC. Сохраните изменения и откройте страницу заново для обновления контракта. Сверьте состояние с Production: сохранённый черновик ещё не является опубликованным изменением. Доступ предоставляется редактору потока или пользователю с правом документации и видимостью потока. Секреты клиентов не включаются.
- Примеры соответствуют фактическому формату запроса и режиму публикации
- Пользователь входит в Data Bridge; одного ключа API недостаточно для открытия HTML-документации
- Публичная публикация данных не делает техническую документацию общедоступной
Принять · Подготовить · Предоставить
Настройте несколько уровней защиты
Для защищённых адресов выдайте каждой интеграции отдельный ключ API и используйте HTTPS. Передавайте ключи в Authorization: Bearer или X-API-Key, а не в URL. Ключ принадлежит пользователю: права чтения и записи выбранных потоков не могут превышать текущие права владельца. Настройте срок действия, разрешённые IPv4/IPv6-адреса или сети CIDR, ограничения запросов и HMAC-SHA256, включённый по умолчанию. Подпись защищает время, метод, путь с параметрами и хеш тела. Допустимая разница часов — пять минут; повтор подписи отклоняется. Ротация заменяет ключ, отключение клиента прекращает доступ. Согласуйте меры для каждого партнёра.
- 401 указывает на проблему ключа, срока или подписи; 403 — адреса, статуса пользователя или прав
- Ограничения запросов клиента и рабочего пространства возвращают 429 с Retry-After
- IP временно блокируется после 30 неудачных аутентификаций за 15 минут
Для защищённых конечных точек API
Выберите закрытый или публичный доступ
Оставляйте внутренние показатели, партнёрские остатки и личные результаты за ключами и правами. Для открытого справочника, публичного каталога или информационного виджета включите отдельную настройку публичной публикации. После явного подтверждения любой обладатель адреса сможет читать данные без ключа, подписи и проверки прав потока. CORS разрешает запросы других сайтов, поэтому публичному виджету не нужен секрет. Сохраняются ограничения по IP и общему API, страницы, настроенные проверки актуальности и аудит. Открывается только этот адрес: входящие запросы, история, другие результаты и документация сохраняют собственный контроль доступа. Перед включением осознанно выберите поля.
- Защита согласованных интеграций управляемыми ключами клиентов
- Публичные адреса для данных с неограниченным доступом
- Данные виджета из сохранённых результатов, обновляемых по расписанию
Принять · Подготовить · Предоставить
Находите причину ошибки в истории
Idempotency-Key предотвращает новый запуск при повторе той же доставки; изменённое тело с тем же ключом вызывает конфликт. При включённой HMAC-подписи каждому повторному HTTP-запросу нужна новая подпись. Исходящая запись автоматически не повторяется, если внешний сервис уже мог её выполнить: потерянный ответ требует сверки получателя. Настройте размер запроса, очереди, частоту, тайм-ауты и повторы обратных вызовов. Аудит API помогает сопоставить адреса, клиентов, время, статусы и запуски. Хранение тела регулируется отдельно: после очистки данных доставки копия аудита может оставаться согласно его настройкам.
- Предотвращение повторных запусков доставки без обещания общей транзакции внешних систем
- Проверка успеха, неверных полей, повторных ключей и ограничений до внедрения
- Новая версия адреса для согласованного перехода к изменённому контракту
Ответы на ваши вопросы.
Как подключить данные, настроить доступ и начать работу.
Нужно ли программировать отдельный API-сервер?
Настройте адреса и блоки обработки в Data Bridge. Внешние приложения отправляют HTTP-запросы по согласованному контракту.
Проверка типов сама исправляет значения?
Нет. Входная схема проверяет, отдельные блоки преобразуют. Уникальные ключи находят повторы внутри одного запроса, а не среди исторических доставок.
Означает ли HTTP 202, что данные записаны?
Нет. После завершения проверьте run.status и результат получателя. delivery.completed означает завершение, а не обязательно успех.
Чем различаются HMAC и Idempotency-Key?
HMAC проверяет отдельные запросы и отклоняет повтор подписи. Idempotency-Key связывает повторные доставки с первым запуском. При включённой подписи повторам нужны новые подписи.
Могут ли потребители читать без ключа?
Да, через явно включённую публичную публикацию. Любой обладатель адреса может читать данные; документация и остальные маршруты API остаются под контролем доступа.
Каждое чтение заново обращается к источникам?
Нет. Выберите сохранённый результат с контролем актуальности или выполнение по запросу с настраиваемым ожиданием и повторным использованием результата.
Начнём с вашей задачи.
Расскажите, какие данные нужно объединить. Мы объясним, как это работает, и покажем пример.
Расскажите о задаче. Найдём путь к решению.
Источники, правила и результаты — обсудим их на примере вашего процесса.