Skava Skava / Wiki

Пользовательские элементы: API

API-интерфейс — это форма, чьи заполненные значения Skava отправляет как JSON на адрес, который вы указываете (ваш бэкэнд). Таким образом, вы можете безопасно подключить Skava к своим собственным системам.

i

Вы управляете API-интерфейсами в Веб-приложении в разделе Пользовательские элементы → переключить API-интерфейсы. Создание и редактирование зарезервированы для администраторов компании; выпущенные интерфейсы затем могут быть запущены всеми членами компании.

Настройка API-интерфейса

Интерфейс состоит из полей ввода (они образуют JSON), целевого адреса и аутентификации.

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

Безопасное хранение токена

Токен хранится зашифрованным и никогда не возвращается клиентам — приложение показывает только есть ли токен установлен и когда он истечёт. При отправке Skava добавляет его серверной стороной к настроенному заголовку. Если вы устанавливаете дату истечения, Skava отказывает звонок после истечения и просит вас обновить токен.

Тестирование: Ping и тестовый запрос

  • Ping — лёгкая проверка доступности. Он только проверяет отвечает ли ваш адрес и не отправляет токен или данные формы в процессе. Показывает доступность, статус и время отклика. Идеально как первый шаг.
  • Тестовый запрос — реальный пробный прогон: отправляет образец данных, включая токен, на ваш адрес и показывает вам полный ответ, а также извлечённые поля ответа.

Как администратор, вы можете запустить оба, пока всё ещё в режиме черновика, чтобы проверить интеграцию перед выпуском.

Черновик и выпуск

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

!

Выпущенные интерфейсы неизменяемы. Это преднамеренно: чтобы после выпуска никто не мог тайно поменять целевой адрес или токен. Если вы хотите что-то изменить, создайте новую версию.

Безопасность

i

Чтобы предотвратить неправомерное использование интерфейса, действуют строгие правила: разрешены только HTTPS адреса, и адрес должен указывать на общедоступный целевой адрес — внутренние адреса (например, localhost, частные сети или облачные метаданные) отклоняются. Skava проверяет это при каждом вызове, подключается ровно к проверенному адресу, не следует перенаправлениям и ограничивает тайм-аут и размер ответа.

Связанные

Вы вместо этого хотите построить заполняемый шаблон документа? См. Пользовательские элементы: Документы.

Часто задаваемые вопросы

Что такое API-интерфейс в Skava?

Форма, чьи заполненные значения Skava отправляет как JSON на адрес, который вы указываете (ваш бэкэнд) — полезно для подключения Skava к своим собственным системам.

Кому разрешено создавать и запускать API-интерфейсы?

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

В чём разница между «Ping» и «Тестовым запросом»?

Ping только проверяет, доступен ли адрес — без токена и без данных. Тестовый запрос отправляет образец данных, включая токен, и показывает полный ответ.

Безопасен ли мой API токен?

Да. Токен хранится зашифрованным и никогда не доставляется клиентам. Приложение показывает только, установлен ли токен и когда он истечёт.

Какие адреса разрешены как конечные точки?

Только общедоступные https:// адреса. Внутренние цели, такие как localhost, частные сети или облачные метаданные, отклоняются — это защищает от неправомерного использования интерфейса.

Почему я больше не могу изменить выпущенный интерфейс?

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