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. проверите с пинг и тестова заявка, след това освободете.

съхранявайте токен безопасно

токенът е съхраняван криптиран и никога не се връща на клиентите — приложението само показва дали е задан токен и когато изтича. при изпращане Skava го добавя на сървър към конфигурираната заглавка. ако зададете дата на изтичане, Skava отказва обаждането след изтичане и ви пита да обновите токена.

тестване: пинг и тестова заявка

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

като администратор можете да работите и двете, докато все още сте в режим на черновата, за да потвърдите интеграцията преди освобождаване.

чернова и освобождаване

всеки интерфейс начина като чернова и може свободно да бъде редактирана. когато всичко е готино вы го освобождавате с освободете.

!

освободени интерфейси са непроменяеми. това е намерено: така че след освобождаване никой не може тайно да замени целевия адрес или токен. ако искате да промените нещо, създайте нова версия.

безопасност

i

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

свързано

искате ли вместо това да градите попълваем шаблон на документ? вижте персонализирани елементи: документи.

често задавани въпроси

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

форма, чиито попълнени стойности Skava изпраща като JSON на адрес, който вы определяте (вашия бекенд) — хендян за свързване на Skava със собствените си системи.

кой е позволено да създава и активирам API интерфейси?

създаването и редактирането е резервирано за администратори на фирма. освобожден интерфейс може тогава да се активира от всички членове на фирма.

каква е разликата между "пинг" и "тестова заявка"?

пинг только проверява дали адресът е достъпен — без токен и без данни. тестова заявка изпраща примерни данни, включително токен и показва пълния отговор.

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

да. токенът се съхранява криптиран и никога не се доставя на клиентите. приложението само показва дали е задан токен и когато изтича.

кои адреси са позволени като крайни точки?

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

защо повече не мога да променя освобожден интерфейс?

освободени интерфейси са намерено непроменяеми — така че след освобождаване никой не може да замени целевия адрес или токен. за промени създайте нова версия.