1. Створіть підключення до ресурсу
У «Підключення → REST API» виберіть напрям «Звернення до зовнішнього API». Задайте зрозумілу назву, HTTPS-базу сервісу й відносний шлях ресурсу, наприклад /orders. Одне підключення описує ресурс і метод запиту. Для іншого ресурсу або іншого методу створіть окреме підключення: це робить призначення й права кожної інтеграції явними.
У шляху не додавайте рядок запиту після знака питання. Базові параметри введіть по одному name=value в рядку; блок джерела може додати власні параметри. Додаткові заголовки задавайте як Name: value. Секрети, включно з Authorization, вводяться спеціальними полями автентифікації, а не звичайними заголовками.
2. Налаштуйте вхід і мережу
Оберіть спосіб, який підтримує зовнішній сервіс: без автентифікації, Basic, Bearer, ключ API в заголовку або OAuth2 client credentials. Для Basic задайте користувача й пароль; для API key — назву заголовка та ключ; для OAuth2 — адресу токена, Client ID, client secret і потрібний scope. Не використовуйте ключ вхідної точки Data Bridge замість реквізитів зовнішнього сервісу.
Перевірте DNS, порт, довіру до TLS-сертифіката та дозволи облікового запису. Для внутрішнього ресурсу використовуйте дозволений мережевий маршрут або налаштований UBC Agent. «Тест» перевіряє доступність; успіх не гарантує права читати кожний ресурс чи виконувати запис. Збережіть підключення лише після перевірки діагностики.
3. Прочитайте й розберіть відповідь
Для джерела використовуйте GET або POST. POST-читання має власне тіло запиту у вибраному форматі; це окремий сценарій від надсилання рядків отримувачем. Формат відповіді задається явно або за Content-Type: JSON, XML, CSV/TSV, JSON Lines. Перевірте кодування, роздільник та наявність заголовків.
Якщо відповідь має вигляд нижче, шлях записів — data.items. Для XML потрібен шлях елементів, наприклад ./item; за потреби можна додати атрибути батьків. Вкладені об’єкти перетворюються на колонки з крапкою. Додайте підключення як джерело, перегляньте поля й лише тоді будуйте фільтр або мапінг.
{"data":{"items":[{"orderId":"ORD-1042","status":"open","amount":1250}]}}4. Налаштуйте всі сторінки
Узгодьте режим із контрактом сервісу: одна відповідь, next-link у JSON/XML, заголовок Link, номер сторінки або offset. Для номера сторінки задайте назву параметра, початковий номер і розмір; для offset — параметр зміщення й порцію. За next-link у тілі задайте точний шлях; посилання має залишатися на тому самому сервері.
Обмежте найбільшу кількість сторінок і таблицю відповіді. Наприклад, сервіс із параметрами page і page_size не можна читати як offset, навіть якщо перша сторінка виглядає правильно. Перевірте щонайменше дві сторінки, останню неповну порцію та відсутність повторених ключів. Для CSV і JSON Lines next-link із тіла не застосовується.
5. Передайте рядки отримувачем
Для запису оберіть POST, PUT або PATCH і формат JSON, XML, форму чи CSV. Отримувач формує тіло з вхідної таблиці. JSON надсилає об’єкт рядка або масив об’єктів; за потреби задайте ключ масиву пакета. XML потребує елемента рядка та кореня пакета. Форма підтримує лише окремий запит для кожного рядка. CSV містить заголовок і значення.
У режимі окремих запитів можна використати шлях /orders/{{orderId}}. Налаштуйте розмір пакета відповідно до API, підготуйте невеликий тест і перевірте ціль за ключем. Метод PUT або PATCH має семантику зовнішнього сервісу: не припускайте автоматичного upsert чи ідемпотентності, якщо його контракт цього не визначає.
6. Перевірте відмови й журнал
У «Налаштування → API → Ліміти API» адміністратор керує повторами, паузами, Retry-After і запобіжником сервера. Тимчасові помилки читання можуть повторюватися; запис повторюється лише коли його точно не прийнято, наприклад з’єднання не встановлено або отримано HTTP 429. Втрачена відповідь на запис залишається невизначеною: спочатку звірте ціль.
Через контекстне меню блоку «Запити API» перевірте метод, адресу, статус і тривалість. Тестуйте 401/403, порожню відповідь, зміну схеми та ліміт сторінок. Зіставте журнал із результатом блоку й підсумковою кількістю записів. Для керованого приймання зовнішніх запитів потрібен інший напрям — вхідна точка API.