Определите, кто начинает обмен
API UBC Data Bridge — интерфейс для обмена между программами — связывает внешние системы с управляемыми потоками. Сначала определите, кто отправляет запрос и какой результат ему нужен. Это задаёт нужное направление подключения «REST API» и помогает избежать лишнего промежуточного кода.
- Обращение к внешнему API: Data Bridge читает записи другого сервиса или передаёт ему строки.
- Приём данных в Data Bridge: партнёр отправляет таблицу или файл; принятая доставка запускает поток Production.
- Выдача данных потока: потребитель читает подготовленный набор или запрашивает результат нового запуска.
Подготовьте среду и ответственных
Администратор проверяет HTTPS-адрес установки, маршрутизацию API через прокси и «Настройки → API → Лимиты API → API Data Bridge включён». Назначьте владельца интеграции, автора потока и пользователя-владельца ключа. Получателям нужны реальные права на целевые объекты: доступ к API сам по себе не открывает таблицу, куб или почтовый сервер.
Начните в тестовой среде с небольшого набора без персональных данных. Согласуйте схему полей, ключи записей, допустимые форматы, ожидаемое время ответа и поведение повтора. Определите, кто сверяет частичный результат.
Настройте подключение и поток
- В «Подключениях» создайте «REST API», выберите направление и название, отличающее тест от рабочей среды.
- Заполните поля направления. Внешнему сервису нужны адрес, метод и аутентификация; собственной точке — версия API, идентификатор и правила ответа.
- Добавьте соответствующий блок конструктора: подключение-источник/получатель, «Входные данные API» или «Выдача данных API».
- Настройте преобразования, проверки и получателей. Просмотрите таблицы и выполните симуляцию.
- Сохраните и опубликуйте Production. Клиентские запросы используют опубликованный поток; сохранение черновика его не заменяет.
Адреса и версии
Версия API — часть адреса точки, например v1 или v1.1. Она не связана с версией продукта UBC Data Bridge 2.1.1. Копируйте полный адрес из формы: установка может включать префикс /databridge , код среды и отдельный путь Конструктора. Точки и ключи разных сред не взаимозаменяемы.
Основные маршруты: POST /api/v1/inbound/orders для приёма; GET /api/v1/data/stock для набора данных; GET /api/v1/ping для проверки ключа и времени; GET /api/v1/flows для доступных потоков. orders и stock — примеры идентификаторов, которые нужно создать в своей установке.
Разделяйте область ключа и права пользователя
Для защищённой входной точки создайте API-клиента с правом «Запись» нужного потока; для чтения нужно «Чтение». Ключ действует от имени владельца и не расширяет его права. Передавайте его через Authorization: Bearer или X-API-Key, но не в URL. Если включён HMAC — подпись запроса общим секретом, — каждому запросу также нужны собственные время и подпись.
Публичный доступ относится только к явно открытой точке выдачи. Он не открывает приём, историю или техническую документацию. Правила ключей и пример подписи приведены в руководстве по API-клиентам.
Проверьте полный цикл
Успешный HTTP-запрос не доказывает завершения бизнес-операции. Входная точка может вернуть 202: сохраните идентификатор доставки и перейдите по Location. При выдаче с запуском по запросу используйте next для ожидания того же запуска. Сравните статус, число строк и конкретную запись в целевой системе.
Отдельно проверьте неправильное поле, отсутствие прав, повтор ключа идемпотентности и превышение лимита. Идемпотентность защищает от повторного выполнения одной доставки. В «Настройки → API → Аудит запросов» найдите запрос по потоку или подключению. Сопоставьте его с журналом запуска и определите безопасный объём повтора после частичной или неподтверждённой записи.
Продолжите с нужным руководством
Приём данных и файлов описывает схемы, доставки и обратные вызовы. Обращения к внешним API объясняют чтение, постраничную выборку и запись. Выдача данных описывает режимы актуальности и параметры. Руководство по технической документации точки объясняет, как передать настройки интегратору.