Skava Skava / Wiki

Vlastní prvky: API

API rozhraní je formulář, jehož vyplněné hodnoty Skava posílá jako JSON na adresu, kterou zadáte (váš backend). Takto můžete bezpečně připojit Skava k vašim vlastním systémům.

i

API rozhraní spravujete v Webové aplikaci v sekci Vlastní prvky → přepínač API rozhraní. Vytváření a úpravy jsou vyhrazeny správci firmy; uvolněná rozhraní pak mohou spustit všichni členové firmy.

Nastavení API rozhraní

Rozhraní se skládá ze vstupních polí (tvoří JSON), cílové adresy a ověřování.

  1. Vytvořit pole: Každé pole dostane klíč JSON. Vpravo vidíte živě náhled JSON, který se posílá na váš backend přesně tímto způsobem.
  2. Adresa (URL): adresa https:// vašeho backendu. Povoleny jsou pouze HTTPS a veřejně dostupné adresy (viz Bezpečnost níže).
  3. Metoda: POST (výchozí), PUT, PATCH nebo GET. Při GET se hodnoty připojují jako parametry dotazu místo odesílání v těle.
  4. Ověřování: Nastavte jméno záhlaví (např. Authorization) a prefiks hodnoty (např. Bearer ), pak uložte token. Volitelně nastavte datum vypršení.
  5. Pole odpovědi (volitelné): Definujte cestou, které hodnoty z odpovědi backendu se mají zobrazit — např. order.id nebo items[0].sku.
  6. Zkontrolujte pomocí Ping a Zkušební požadavek, pak Uvolnit.

Bezpečné uložení tokenu

Token je uložen šifrován a nikdy se nevrátí klientům — aplikace zobrazí pouze zda je token nastaven a kdy vyprší. Při odesílání Skava připojí token na straně serveru k nakonfigurovanému záhlaví. Pokud nastavíte datum vypršení, Skava po vypršení odmítne volání a požádá vás o obnovení tokenu.

Testování: Ping a zkušební požadavek

  • Ping — lehká kontrola dostupnosti. Kontroluje pouze zda vaše adresa reaguje a při tom neposílá token ani data formuláře. Zobrazuje dostupnost, stav a čas odezvy. Ideální jako první krok.
  • Zkušební požadavek — skutečný pokus: posílá vzorová data včetně tokenu na vaši adresu a zobrazuje vám kompletní odpověď a také extrahovaná pole odpovědi.

Jako správce můžete oba spustit, zatímco je rozhraní stále v návrhu, aby se ověřila integrace před uvolněním.

Návrh a uvolnění

Každé rozhraní začíná jako návrh a lze jej volně upravovat. Jakmile je vše připraveno, uvolníte jej pomocí Uvolnit.

!

Uvolněná rozhraní jsou neměnná. To je záměr: aby po uvolnění nikdo nemohl tajně vyměnit cílovou adresu nebo token. Pokud chcete něco změnit, vytvořte novou verzi.

Bezpečnost

i

Aby se rozhraní nemohlo zneužít, platí přísná pravidla: povoleny jsou pouze HTTPS adresy a adresa musí ukazovat na veřejný cíl — interní adresy (např. localhost, soukromé sítě nebo metadata v cloudu) se odmítají. Skava to kontroluje při každém volání, připojuje se přesně na ověřenou adresu, nesleduje přesměrování a omezuje timeout a velikost odpovědi.

Related

Chcete místo toho vytvořit vyplňovací šablonu dokumentu? Viz Vlastní prvky: Dokumenty.

Často kladené otázky

Co je API rozhraní v Skava?

Formulář, jehož vyplněné hodnoty Skava posílá jako JSON na adresu, kterou zadáte (váš backend) — praktické pro připojení Skava k vašim vlastním systémům.

Kdo smí vytvářet a spouštět API rozhraní?

Vytváření a úpravy jsou vyhrazeny správci firmy. Uvolněné rozhraní pak mohou spustit všichni členové firmy.

Jaký je rozdíl mezi "Ping" a "Zkušebním požadavkem"?

Ping pouze kontroluje, zda je adresa dostupná — bez tokenu a bez dat. Zkušební požadavek posílá vzorová data včetně tokenu a zobrazuje kompletní odpověď.

Je můj API token bezpečný?

Ano. Token je uložen šifrován a nikdy se neposílá klientům. Aplikace zobrazí pouze, zda je token nastaven a kdy vyprší.

Které adresy jsou povoleny jako koncové body?

Pouze veřejně dostupné adresy https://. Interní cíle jako localhost, soukromé sítě nebo metadata v cloudu se odmítají — to chrání před zneužitím rozhraní.

Proč už nemohu měnit uvolněné rozhraní?

Uvolněná rozhraní jsou záměrně neměnná — aby po uvolnění nikdo nemohl vyměnit cílovou adresu nebo token. Na změny vytvoříte novou verzi.