API Key

API Key — це метод автентифікації, при якому доступ до сервісу надається через унікальний секретний ключ (рядок символів). Він дозволяє самостійно визначити назву ключа та спосіб його передачі у заголовках або як частину URL-адреси.

Навігація

1. Призначення, розташування та особливість
2. Налаштування блоку
3. Додавання акаунту та ініціалізація запуску
4. Механізм роботи (Header vs Query)
5. FAQ

Призначення, розташування та особливість

─────────────────────────────────────────────────────────────-

Блок використовується виключно у флоу Authentication. Він вказує платформі, який технічний заголовок або параметр запиту очікує провайдер API (наприклад, X-API-KEY або access_token).  

Як це працює:

1. Ви додаєте блок у Authentication Flow.
2. Система активує поле для вводу API ключа з назвою прописаною в "Variable Label" у вікні Flow Test.  
3. Платформа автоматично зберігає API ключ і підставляє у кожен HTTP-запит.  

Налаштування блоку

─────────────────────────────────────────────────────────────-

Блок API Key має обов'язкові поля для конфігурації в розділі Settings, які визначають, як саме ключ буде передаватися в запитах.

1 -> Variable Name: Технічна назва ключа з документації API. Саме цей ключ побачить сервер (наприклад: api_key, X-Auth-Token, token).

2 -> Variable Label: Назва поля, яку побачить кінцевий користувач під час підключення акаунту (наприклад: "API key").

3 -> Add Variable to: Визначає місце куди саме буде доданий API ключ в HTTP-запиті:

• Header: Ключ передається в заголовки запиту.
• Query Params: Ключ додається в кінець URL-адреси у вигляді параметра.

Додавання акаунту та ініціалізація запуску (Flow Test)

─────────────────────────────────────────────────────────────-

Після того, як ви налаштували блок API Key як метод автентифікації, необхідно створити реальне підключення та ініціалізувати тестовий запуск, щоб система «побачила» ці дані.

Цей порядок є обовʼязковим для коректної роботи API Key-автентифікації.

Покрокова інструкція підключення:

1 -> Кнопка Flow Test: У нижній лівій частині екрану натисніть кнопку Flow Test. Відкриється панель налаштування тесту, де проводиться підключення акаунту та запуск інтеграції.

2 -> Кнопка Add New Account: Натисніть Add New Account, щоб додати нове підключення для авторизації.

3 -> Заповнення даних: У вікні, що з'явилося, заповніть наступні поля:

• 4 -> Name: вкажіть зрозуміле ім'я для вашого підключення (наприклад, "Prod auth"), для майбутньої швидкої ідентифікації.
• 5 -> [Variable Label]:  Замість стандартного поля "Token" ви побачите назву, яку прописали в налаштуваннях блоку (наприклад, "API Key"). Саме сюди вставляється реальний API ключ.

6 -> Save: Натисніть кнопку Save всередині спливаючого вікна, щоб зберегти введені дані нового акаунту.

7 -> Вибір акаунту: У списку акаунтів оберіть щойно створений акаунт.

8 -> Кнопка Save (у Flow Test): Натисніть Save на панелі Flow Test. Це закріпить обраний акаунт за поточною сесією розробки.

9 -> Кнопка Run Test: Натисніть Run Test, щоб ініціалізувати запуск інтеграції. Це критично важливий крок: саме на цьому етапі платформа  робить API ключ доступними для інших флоу ( Account Validation, Main Action тощо).

Механізм роботи (Header vs Query)

─────────────────────────────────────────────────────────────-

Залежно від обраного пункту в полі Add Variable to, платформа автоматично змінює структуру ваших HTTP-запитів:

Header (Заголовки)

Якщо обрано Header, то до кожного запиту в системі буде автоматично додано рядок: [Variable Name]: [Ваш API ключ]
Приклад: X-API-KEY: as7fsadfsd7f6sd...

Query Params (Параметри URL)

Якщо обрано Query Params, то до вашого URL буде автоматично додано параметр: [Variable Name]=[Ваш API ключ]
Приклад: .../get_users?api_key=as7fsadfsd7f6sd...

FAQ

─────────────────────────────────────────────────────────────-

1. Чи потрібно мені вручну додавати ключ до кожного блоку HTTP Request?
Ні. Платформа зробить це за вас автоматично. Якщо ви обрали Header, ключ буде в заголовках, якщо Query Params — він сам приклеїться до URL.

2. Чому мій запит видає помилку "Missing API Key", хоча акаунт підключено?
Перевірте дві речі: 1) Чи правильно вказано Variable Name (регістр літер має значення). 2) Чи був виконаний Run Test після вибору акаунту.

3. Чи працює API Key у Account Validation Flow?
Так. Усі запити в Account Validation виконуються вже з підключеним API Key. Некоректний ключ призведе до невалідного акаунту.

4. Чи можна змінити API Key без редагування флоу?
Так. Достатньо відредагувати акаунт у Flow Test, зберегти зміни та повторно виконати Run Test.