Оберіть, хто починає обмін
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 пояснює читання, сторінки й запис. Видача даних містить режими актуальності та параметри. Технічний довідник точки допоможе передати налаштування інтегратору.