Skava Skava / Wiki

Користувацькі елементи: API

API інтерфейс — це форма, чиї заповнені значення Skava відправляє як JSON на адресу, яку ви вказуєте (ваш backend). Таким чином ви можете безпечно з'єднати Skava зі своїми власними системами.

i

Ви керуєте API інтерфейсами у веб-додатку в розділі Користувацькі елементи → перемикач API інтерфейси. Створення та редагування зарезервовані для адміністраторів компанії; випущені інтерфейси можуть потім запускатися всіма членами компанії.

Налаштування API інтерфейсу

Інтерфейс складається з полів введення (вони формують JSON), цільової адреси та аутентифікації.

  1. Створіть поля: Кожне поле отримує ключ JSON. Праворуч ви бачите в реальному часі попередження JSON, яке відправляється на ваш backend саме так.
  2. Адреса (URL): адреса https:// вашого backend. Дозволені лише адреси HTTPS та публічно доступні (див. безпеку нижче).
  3. Метод: POST (за замовчуванням), PUT, PATCH або GET. За допомогою GET значення додаються як параметри запиту замість відправлення в тілі.
  4. Аутентифікація: встановіть ім'я заголовка (наприклад, Authorization) та префікс значення (наприклад, Bearer ), потім збережіть токен. За бажанням встановіть дату закінчення.
  5. Поля відповіді (за бажанням): Визначте за шляхом, які значення з відповіді backend повинні відображатися — наприклад, order.id або items[0].sku.
  6. Перевірте за допомогою Пінг та Тестовий запит, потім Випустіть.

Зберігайте токен безпечно

Токен зберігається зашифрованим і ніколи не повертається клієнтам — додаток показує лише чи встановлено токен та коли він закінчується. При відправленні Skava додає його на стороні сервера до налаштованого заголовка. Якщо ви встановите дату закінчення, Skava відмовляє виклику після закінчення та просить вас оновити токен.

Тестування: пінг та тестовий запит

  • Пінг — лаганка перевірка доступності. Вона перевіряє лише чи ваша адреса відповідає, та не відправляє токен чи дані форми у процесі. Показує доступність, статус та час відповіді. Ідеально як перший крок.
  • Тестовий запит — справжнє пробне запуск: відправляє зразкові дані, включаючи токен, на вашу адресу та показує вам повну відповідь, а також витяги поля відповіді.

Як адміністратор, ви можете запустити обидва, поки перебуваєте в режимі чернетки, щоб перевірити інтеграцію перед випуском.

Чернетка та випуск

Кожен інтерфейс починається як чернетка і може бути вільно редагований. Коли все готово, ви його випускаєте за допомогою Випустіть.

!

Випущені інтерфейси незмінні. Це навмисно: щоб після випуску ніхто не міг таємно обміняти цільову адресу чи токен. Якщо ви хочете щось змінити, створіть нову версію.

Безпека

i

Щоб запобігти неправомірному використанню інтерфейсу, застосовуються суворі правила: дозволені лише адреси HTTPS, і адреса повинна вказувати на публічну цільову адресу — внутрішні адреси (наприклад, localhost, приватні мережі чи хмарні метадані) відхиляються. Skava перевіряє це при кожному виклику, з'єднується точно з перевіреною адресою, не слідує перенаправленням та обмежує час очікування та розмір відповіді.

Пов'язано

Чи ви скоріше хочете побудувати заповнювану шаблон документа? Див. Користувацькі елементи: документи.

Часто задавані запитання

Що таке API інтерфейс в Skava?

Форма, чиї заповнені значення Skava відправляє як JSON на адресу, яку ви вказуєте (ваш backend) — зручно для з'єднання Skava з вашими власними системами.

Хто може створювати та запускати API інтерфейси?

Створення та редагування зарезервовані для адміністраторів компанії. Випущений інтерфейс потім може бути запущений всіма членами компанії.

Яка різниця між "пінгом" та "тестовим запитом"?

Пінг перевіряє лише доступність адреси — без токена та без даних. Тестовий запит відправляє зразкові дані, включаючи токен, та показує повну відповідь.

Чи мій API токен безпечний?

Так. Токен зберігається зашифрованим і ніколи не доставляється клієнтам. Додаток показує лише чи встановлено токен та коли він закінчується.

Які адреси дозволені як кінцеві точки?

Лише публічно доступні адреси https://. Внутрішні цілі, такі як localhost, приватні мережі чи хмарні метадані, відхиляються — це захищає від неправомірного використання інтерфейсу.

Чому я більше не можу змінювати випущений інтерфейс?

Випущені інтерфейси навмисно незмінні — щоб після випуску ніхто не міг обміняти цільову адресу чи токен. Для змін ви створюєте нову версію.