Прилагођени елементи: API
API интерфејс је образац чије попуњене вредности Скава шаље као JSON на адресу коју си одредио (твоја позадина). На овај начин можеш безбедно повезати Скаву са својим системима.
Управљаш API интерфејсима у веб апликацији под Прилагођени елементи → укључи API интерфејсе. Креирање и уређивање је задржано за администраторе фирме; пуштени интерфејси могу онда бити активирани од стране свих чланова фирме.
Постави API интерфејс
Интерфејс се sastoji од поља за унос (она чине JSON), циљне адресе и аутентификације.
- Направи поља: Свако поље добија JSON кључ. На десној страни видиш у директном приказу JSON преглед, који се шаље твојој позадини баш на овај начин.
- Адреса (URL): адреса твоје позадине са
https://. Дозвољене су само HTTPS и јавно доступне адресе (види Безбедност испод). - Метода:
POST(подразумевано),PUT,PATCH, илиGET. СаGETсе вредности приложу као параметри упита уместо да буду послане у телу. - Аутентификација: Постави име заглавље (нпр.
Authorization) и префикс вредности (нпр.Bearer), затим сачувај токен. По жељи постави датум истека. - Поља одговора (опционално): Дефиниши по путањи која вредност из позадинског одговора би требала бити приказана — нпр.
order.idилиitems[0].sku. - Провери са Пинг и Захтев за тест, затим Пусти у рад.
Безбедно похрани токен
Токен је похрањен шифрован и никада се не враћа клијентима — апликација показује само да ли је токен постављен и када истиче. При слању, Скава его додаје на серверској страни прилике конфигурисаном заглављу. Ако си постави датум истека, Скава одбија позив после истека и замоли те да обновиш токен.
Тестирање: Пинг и захтев за тест
- Пинг — лака проверка приступачности. Он проверава само да ли твоја адреса одговара, и не шаље токен или податке образца у процесу. Показује приступачност, статус и време одговора. Идеално као први корак.
- Захтев за тест — прави пробни ток: шаље узорке са токеном твојој адреси и показује ти комплетан одговор као и извучена поља одговора.
Као администратор, можеш да покренеш оба док је још у нацрту да проверишь интеграцију пре него што је пустиш у рад.
Нацрт и пуштање у рад
Сваки интерфејс почиње као нацрт и може бити слободно уређиван. Када је све спремно, га пускиш у рад са Пусти у рад.
Пуштени интерфејси су непроменљиви. Ово је намерно: да после пуштања у рад нико тајно не може да замени циљну адресу или токен. Ако желиш нешто да измениш, направи нову верзију.
Безбедност
Да спречиш интерфејс од злоупотребе, строга правила се примењују: само HTTPS адресе су дозвољене и адреса мора да показује на јавну циљну адресу — унутрашње адресе (нпр. localhost, приватне мреже, или метаподаци облака) су одбијени. Скава то проверава при сваком позиву, повезује се баш на проверену адресу, не следи преусмеревања и ограничава време истека и величину одговора.
Релевантно
Да ли уместо тога желиш да направиш шаблон попуњивог документа? Види Прилагођени елементи: Документи.
Често постављана питања
Шта је API интерфејс у Скави?
Образац чије попуњене вредности Скава шаље као JSON на адресу коју си одредио (твоја позадина) — пригодно за повезивање Скаве са твојим системима.
Ко је дозвољен да направи и активира API интерфејсе?
Креирање и уређивање је задржано за администраторе фирме. Пуштен интерфејс онда могу да активирају сви чланови фирме.
Која је разлика између "Пинг" и "захтева за тест"?
Пинг само проверава да ли је адреса приступачна — без токена и без података. Захтев за тест шаље узорке са токеном и показује комплетан одговор.
Да ли је мој API токен безбедан?
Да. Токен је похрањен шифрован и никада није испоручен клијентима. Апликација показује само да ли је токен постављен и када истиче.
Која адреса су дозвољена као крајње тачке?
Само јавно доступне https:// адресе. Унутрашње циљне адресе као што су localhost, приватне мреже, или метаподаци облака су одбијени — ово штити од злоупотребе интерфејса.
Зашто више не могу да измениам пуштен интерфејс?
Пуштени интерфејси су намерно непроменљиви — да после пуштања у рад нико не може да замени циљну адресу или токен. За измене, направиш нову верзију.