Skava Skava / Wiki

Egyéni elemek: API

Az API felület egy olyan forma, amelynek kitöltött értékeit a Skava JSON-ként egy megadott címre (a háttérrendszeredre) küldi. Így a Skavat biztonságosan csatlakoztathatod a saját rendszeredhez.

i

Az API felületeket a Webalkalmazásban kezeled a céged Egyéni elemek → váltás az API felületek között. A létrehozás és a szerkesztés a céges adminisztrátorokra korlátozódik; a kiadott felületek azt a cég összes tagja használhatja.

Az API felület beállítása

A felület a beviteli mezőkből (JSON képeznek), a céladresből és a hitelesítésből áll.

  1. Mezők létrehozása: Minden mező egy JSON kulcsot kap. A jobb oldalon a JSON előnézet élő, amely pontosan így küldődik a háttérrendszeredre.
  2. Cím (URL): a háttérrendszer https:// címe. Csak HTTPS és nyilvánosan elérhető címek engedélyezatok (lásd az alábbiakban a biztonság).
  3. Módszer: POST (alapértelmezett), PUT, PATCH, vagy GET. GET segítségével az értékek lekérdezési paraméterként kerülnek az URL-hez, nem a törzsben.
  4. Hitelesítés: Állítsd be a fejléc nevet (pl. Engedély) és az érték előtagot (pl. Bearer ), majd ment a tokent. Opcionálisan állíts be egy lejárati dátumot.
  5. Válasz mezők (opcionális): Határozz meg az útvonal alapján, mely értékeket a háttérrendszer válaszából kell megjeleníteni — pl. megrendelés.id vagy elemek[0].sku.
  6. Ellenőrizd a Ping és a Teszt kérés segítségével, majd Kiad.

A token biztonságos tárolása

A token titkosítva van tárolva, és soha nem adott vissza az ügyfeleknek — az alkalmazás csak azt mutatja, hogy be van-e állítva a token, és mikor jár le. Küldéskor a Skava a konfigurált fejléchez szerver oldalon hozzáfűzi. Ha lejárati dátumot állítasz be, a Skava megtagadja a hívást a lejárat után, és kéri a token megújítását.

Tesztelés: Ping és Teszt kérés

  • Ping — egy könnyű elérhetőségi ellenőrzés. Csak azt ellenőrzi, hogy a te cím válaszol-e, és token vagy forma adatokat nem küld el a folyamat alatt. Mutatja az elérhetőséget, az állapotot és a válaszidőt. Ideális az első lépésként.
  • Teszt kérés — a valódi próbamenet: minta adatokat, beleértve a tokent küld a címedre, és mutatja a teljes válaszot és a kinyert válasz mezőket.

Mint admin, mindkét lehetőséget futtathatod a kiadás előtt is, hogy ellenőrizd az integrációt.

Tervezet és kiadás

Minden felület tervezetként kezdődik, és szabadon szerkeszthető. Amint mindent elkészültél, Kiad gombbal adod ki.

!

A kiadott felületek megváltoztathatatlak. Ez szándékos: hogy a kiadás után senki sem cserélheti meg titokban a céladreszt vagy a tokent. A módosításokhoz hozz létre egy új verziót.

Biztonság

i

A felület potenciális visszaélésének megelőzésére szigorú szabályok vonatkoznak: csak HTTPS-címek engedélyezatok, és a cím egy nyilvános céladresre kell mutatnia — belső címek (pl. helyi gazdagép, privát hálózatok vagy felhő metaadatok) vissza vannak utasítva. A Skava ezt minden híváskor ellenőrzi, pontosan az ellenőrzött címre csatlakozik, nem követ átirányításokat, és korlátozza az időtúllépést és a válasz méretét.

Kapcsolódó

Helyette szeretnél egy kitölthető dokumentumsablont építeni? Lásd az Egyéni elemek: Dokumentumok oldalt.

Gyakran Feltett Kérdések

Mi az API felület a Skavaban?

Egy olyan forma, amelynek kitöltött értékeit a Skava JSON-ként egy megadott címre (a háttérrendszeredre) küldi — praktikus a Skava a saját rendszerekhez való csatlakoztatásához.

Ki jogosult az API felületek létrehozásához és aktiválásához?

A létrehozás és a szerkesztés a céges adminisztrátorokra korlátozódik. A kiadott felületet ezt a cég összes tagja aktiválhatja.

Mi a különbség a "Ping" és a "Teszt kérés" között?

Ping csak azt ellenőrzi, hogy a cím elérhető-e — token és adat nélkül. Teszt kérés minta adatokat küld, beleértve a tokent, és mutatja a teljes válaszot.

Biztonságos az API tokenem?

Igen. A token titkosítva van tárolva, és soha nem adódik az ügyfeleknek. Az alkalmazás csak azt mutatja, hogy be van-e állítva a token, és mikor jár le.

Mely címek engedélyezatok végpontokként?

Csak nyilvánosan elérhető https:// címek. Belső célok, mint helyi gazdagép, privát hálózatok vagy felhő metaadatok vissza vannak utasítva — ez megvéd a felület potenciális visszaélésétől.

Miért nem tudom módosítani a kiadott felületet?

A kiadott felületek szándékosan megváltoztathatatlak — hogy a kiadás után senki sem cserélheti meg a céladreszt vagy a tokent. A módosításokhoz hozz létre egy új verziót.