Skava Skava / Wiki

Vlastné prvky: API

Rozhranie API je formulár, ktorého vyplnené hodnoty Skava posiela ako JSON na adresu, ktorú zadáte (váš backend). Takto môžete Skava bezpečne pripojiť k vlastným systémom.

i

Rozhrania API spravujete v webovej aplikácii v časti Vlastné prvky → prepínač Rozhrania API. Vytvorenie a úprava sú vyhradené pre správcov firmy; vydané rozhrania potom môžu spustiť všetci členovia firmy.

Nastavenie rozhrania API

Rozhranie pozostáva z vstupných polí (tvoria JSON), cieľovej adresy a autentifikácie.

  1. Vytvárajte polia: Každé pole dostane kľúč JSON. Na pravej strane vidíte v reálnom čase náhľad JSON, ktorý sa posiela na váš backend presne takto.
  2. Adresa (URL): adresa https:// vášho backendu. Sú povolené iba HTTPS a verejne dostupné adresy (pozri bezpečnosť nižšie).
  3. Metóda: POST (predvolené), PUT, PATCH alebo GET. S GET sa hodnoty pripojiť ako parametre dotazu namiesto toho, aby sa poslali v tele.
  4. Autentifikácia: Nastavte názov hlavičky (napr. Autentifikácia) a predpona hodnoty (napr. Bearer ), potom uložte token. Voliteľne nastavte dátum vypršania platnosti.
  5. Polia odpovede (voliteľne): Definujte podľa cesty, ktoré hodnoty z odpovede backendu sa majú zobraziť — napr. poradie.id alebo položky[0].sku.
  6. Skontrolujte pomocou Ping a Žiadosť testu, potom Uverejniť.

Bezpečne uložte token

Token je uložený zašifrovaný a nikdy sa nevracia klientom — aplikácia zobrazuje iba či je token nastavený a kedy vypršuje. Pri odosielaní Skava pripojí token na strane servera k nakonfigurovanej hlavičke. Ak nastavíte dátum vypršania, Skava po vypršení odmietne hovor a požiada vás na obnovenie tokenu.

Testovanie: Ping a testovacia žiadosť

  • Ping — ľahký test dosahového dosahu. Kontroluje iba či vaša adresa reaguje a v procese neposiela token alebo údaje formulára. Zobrazuje dosahnosť, stav a dobu odozvy. Ideálne ako prvý krok.
  • Žiadosť testu — skutočná skúška: odošle vzorové údaje vrátane tokenu na vašu adresu a zobrazí vám úplnú odpoveď, ako aj extrahované polia odpovede.

Ako správca môžete obe spustiť, keď ste stále v režime návrhu, aby ste overili integráciu pred vydaním.

Návrh a vydanie

Každé rozhranie sa spustí ako návrh a dá sa voľne upravovať. Keď je všetko pripravené, vydáte ho pomocou Uverejniť.

!

Vydané rozhrania sú nemenné. Je to zámerné: aby sa po vydaní nikto nemohol tajne vymeniť cieľovú adresu alebo token. Ak chcete zmenu, vytvorte novú verziu.

Bezpečnosť

i

Aby sa zabránilo zneužitiu rozhrania, platia prísne pravidlá: sú povolené iba adresy HTTPS a adresa musí ukazovať na verejný cieľ — vnútorné adresy (napr. localhost, súkromné siete alebo metadáta cloudu) sú odmietnuté. Skava to kontroluje pri každom volaní, pripoja presne na overenú adresu, nesleduje presmerovania a obmedzuje timeout a veľkosť odpovede.

Súvisiace

Chcete namiesto toho vytvoriť vyplniteľnú šablónu dokumentu? Pozri Vlastné prvky: Dokumenty.

Často kladené otázky

Čo je rozhranie API v Skave?

Formulár, ktorého vyplnené hodnoty Skava posiela ako JSON na adresu, ktorú zadáte (váš backend) — handy na pripojenie Skava s vlastnými systémami.

Kto smie vytvoriť a spustiť rozhrania API?

Vytvorenie a úprava sú vyhradené pre správcov firmy. Vydané rozhranie potom môže spustiť ktokoľvek z firmy.

Aký je rozdiel medzi "Ping" a "Žiadosť testu"?

Ping kontroluje iba dosahnosť adresy — bez tokenu a bez údajov. Žiadosť testu posiela vzorové údaje vrátane tokenu a zobrazuje úplnú odpoveď.

Je môj token API bezpečný?

Áno. Token je uložený zašifrovaný a nikdy sa neposiela klientom. Aplikácia zobrazuje iba, či je token nastavený a kedy vypršuje.

Ktoré adresy sú povolené ako koncové body?

Iba verejne dostupné adresy https://. Vnútorné ciele ako localhost, súkromné siete alebo metadáta cloudu sú odmietnuté — to chráni pred zneužitím rozhrania.

Prečo už nemôžem zmeniť vydané rozhranie?

Vydané rozhrania sú zámerné nemenné — aby sa nikto nemohol po vydaní vymeniť cieľovú adresu alebo token. Na zmeny vytvorte novú verziu.