Налаштуйте обмін даними між системами
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
- Об’єднання рядків файлів одного запиту в таблицю для обробки
- Версійована адреса точки й запуск лише опублікованої логіки
Перевіряйте дані одразу після отримання
Додайте тестовий приклад: система сформує поля й запропонує типи. Перевірте текст, ціле або десяткове число, дату, дату й час, логічне значення; позначте обов’язкові поля та прості чи складені унікальні ключі. Наприклад, номер замовлення разом із номером рядка не повинен повторюватися в одній доставці. Це перевірка відповідності, а не автоматична зміна значень. Далі «Мапінг колонок» узгоджує назви, склад і порядок полів; з’єднання з довідниками доповнює дані; «Очищення та контроль даних» застосовує послідовні правила. Порожню суму можна замінити числовим нулем, від’ємну — зупинити як 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
- Підписаний callback повідомляє про завершення доставки; результат запуску перевіряється окремо
Отримуйте й надсилайте дані через API
Data Bridge може сам читати зовнішній сервіс або надсилати йому результат потоку. Наприклад, отримати замовлення CRM, доповнити їх кодами ERP й передати узгоджений пакет у фінансову систему. Для читання налаштовуються GET або POST, структура відповіді та сторінки: next-link, заголовок Link, номер сторінки чи offset. Для передавання — POST, PUT або PATCH, окремий запит на рядок або пакет. Виберіть JSON, XML, форму чи CSV відповідно до контракту отримувача. Автентифікація зовнішнього сервісу має власні реквізити: Basic, Bearer, API-ключ у заголовку або OAuth 2.0 client credentials; відкритий сервіс може працювати без них.
- Шлях, параметри, заголовки, формат і пакетування під вимоги цільового API
- Мапінг структури перед надсиланням замість ручного перекладання полів
- Доступ до дозволених внутрішніх 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 захищає приймання від зайвого запуску при повторі тієї самої доставки; змінене тіло з тим самим ключем дає конфлікт. Кожен повтор HTTP-запиту потребує нового HMAC. Для вихідних записів система не повторює автоматично дію, яку зовнішній сервіс уже міг виконати: втрачена відповідь потребує звірки цілі. Налаштуйте розмір запиту, чергу, частоту, тайм-аути й повтори callback. У журналі API зіставляйте адресу, клієнта, час, статус і запуск. Збереження тіл керується окремо: після очищення даних доставки їхня копія може залишатися в аудиті відповідно до налаштувань.
- Контроль повторів доставки без обіцянки спільної транзакції всіх зовнішніх систем
- Перевірка успіху, помилкового поля, повторного ключа й лімітів до запуску
- Нова версія адреси для погодженого переходу партнерів на змінений контракт
Відповіді на ваші запитання.
Як підключити дані, налаштувати доступ і почати роботу.
Чи потрібно програмувати окремий сервер API?
Точки приймання й видачі налаштовуються в Data Bridge, а логіка — блоками потоку. Зовнішня система має виконувати HTTP-запити за погодженим контрактом.
Чи перевірка типу автоматично виправляє дані?
Ні. Вхідна схема перевіряє значення; зміни задаються окремими блоками. Унікальні ключі вхідного блоку перевіряють повтори в межах одного запиту.
Чи відповідь 202 означає, що дані вже записано?
Ні. Це приймання доставки. Дочекайтеся завершення й перевірте run.status та результат отримувача; навіть delivery.completed означає завершення, а не обов’язково успіх.
Чим відрізняються HMAC та Idempotency-Key?
HMAC перевіряє конкретний HTTP-запит і захищає від повторного підпису. Idempotency-Key пов’язує повтори доставки з першим запуском. Для повтору потрібен новий підпис.
Чи можна видати дані без ключа?
Так, лише через явно ввімкнену публічну точку видачі. Дані отримає будь-хто з адресою; документація й решта API автоматично не відкриваються.
Чи кожне читання заново звертається до джерел?
Ні. Оберіть збережений результат із контролем віку або запуск на запит. Для другого режиму налаштовуються очікування та повторне використання результату.
Почнімо з вашої задачі.
Розкажіть, які дані потрібно поєднати. Ми пояснимо, як це зробити, і покажемо приклад.
Покажіть задачу. Ми покажемо шлях.
Джерела, правила, результат — побудуємо розмову навколо вашого процесу.