Was ist eine API-Schnittstelle in Skava?

Ein Formular, dessen ausgefüllte Werte Skava als JSON an eine von dir hinterlegte https://-Adresse (dein Backend) sendet — praktisch, um Skava mit eigenen Systemen zu verbinden.

Wer darf API-Schnittstellen anlegen und auslösen?

Anlegen und Bearbeiten ist Firmen-Admins vorbehalten. Eine freigegebene Schnittstelle können anschließend alle Mitglieder der Firma auslösen.

Was ist der Unterschied zwischen „Ping“ und „Test-Request“?

Ping prüft nur, ob die Adresse erreichbar ist — ohne Token und ohne Daten. Test-Request sendet Beispieldaten inklusive Token und zeigt die vollständige Antwort.

Ist mein API-Token sicher?

Ja. Der Token wird verschlüsselt gespeichert und nie an Clients ausgeliefert. Die App zeigt nur, ob ein Token gesetzt ist und wann er abläuft.

Welche Adressen sind als Endpunkt erlaubt?

Nur öffentlich erreichbare https://-Adressen. Interne Ziele wie localhost, private Netze oder Cloud-Metadaten werden abgelehnt — das schützt vor Missbrauch der Schnittstelle.

Warum kann ich eine freigegebene Schnittstelle nicht mehr ändern?

Freigegebene Schnittstellen sind bewusst unveränderlich — so kann nach der Freigabe niemand mehr Zieladresse oder Token austauschen. Für Änderungen legst du eine neue Version an.

Po meri prilagojeni elementi: API

API vmesnik je obrazec, katerega izpolnjene vrednosti Skava pošlje kot JSON na naslov, ki ga navedete (vaš backend). Tako lahko Skavo varno povežete z lastnimi sistemi.

API vmesnike upravljate v spletni aplikaciji pod Po meri prilagojeni elementi → preklapljač API vmesniki. Ustvarjanje in urejanje sta rezervirana za skrbnike podjetja; izdani vmesniki se nato lahko sprožijo s strani vseh članov podjetja.

Nastavite API vmesnik

Vmesnik je sestavljen iz vnosnih polj (oblikujejo JSON), ciljnega naslova in avtentifikacije.

Ustvari polja: Vsako polje dobije JSON ključ. Na desni vidite živino predogled JSON, ki se pošlje na vaš backend natanko tako.
Naslov (URL): naslov https:// vašega backenda. Dovoljeni so samo HTTPS in javno dostopni naslovi (glejte Varnost spodaj).
Metoda: POST (privzeto), PUT, PATCH ali GET. Z GET se vrednosti dodajo kot parametri za poizvedbe namesto da bi se pošiljale v telu.
Avtentifikacija: Nastavite ime glave (npr. Authorization) in predpono vrednosti (npr. Bearer ), nato shranite žeton. Izbirno nastavite datum poteka.
Polja odgovora (izbirno): Definirajte s potjo, katere vrednosti iz odgovora backend-a bi morale biti prikazane — npr. order.id ali items[0].sku.
Preverite z Ping in Zahtevek testa, nato Izdaj.

Varno shranite žeton

Žeton je shranjen šifriran in nikoli se ne vrne do odjemalcev — aplikacija samo prikazuje, ali je žeton nastavljen in kdaj poteče. Pri pošiljanju Skava žeton priloži na stran streženika v nastavljeno glavo. Če nastavite datum poteka, Skava zavrne klic po poteku in vas prosi, da obnovite žeton.

Testiranje: Ping in zahtevek testa

Ping — lahka preverjanja dosegljivosti. Samo preveri, ali se vaš naslov odzove, pri procesu ne pošlje žeton ali podatke obrazca. Prikazuje dosegljivost, status in čas odziva. Idealno kot prvi korak.
Zahtevek testa — pravi poskus: pošlje vzorčne podatke vključno z žetonom na vaš naslov in prikazuje celoten odgovor ter pridobljena polja odgovora.

Kot skrbnik lahko zaženete oba tudi v osnutku za preverjanje integracije preden izdajete.

Osnutek in izdaja

Vsak vmesnik se začne kot osnutek in ga je mogoče prosto urejati. Ko je vse pripravljeno, ga izdajte z Izdaj.

Izdani vmesniki so nespremenljivi. To je namerno: tako da po izdaji nihče ne more tajno zamenjati ciljnega naslova ali žetona. Če želite kaj spremeniti, ustvarite novo različico.

Varnost

Da se vmesnik ne bi zlorabil, veljajo stroga pravila: dovoljeni so samo naslovi HTTPS in naslov mora kazati na javni ciljni naslov — notranji naslovi (npr. localhost, zasebna omrežja ali oblačni metapodatki) so zavrnjeni. Skava to preverja pri vsakem klicu, se poveže natanko z preverenim naslovom, ne sledi preusmeritvam in omejuje čas izteka in velikost odziva.

Sorodne

Želite namesto tega zgraditi izpolnjljavo predlogo dokumenta? Glejte Po meri prilagojeni elementi: Dokumenti.

Pogosto zastavljena vprašanja

Kaj je API vmesnik v Skavi?

Obrazec, katerega izpolnjene vrednosti Skava pošlje kot JSON na naslov, ki ga navedete (vaš backend) — priročno za povezovanje Skave z lastnimi sistemi.

Kdo je dovoljen za ustvarjanje in sprožitev API vmesnikov?

Ustvarjanje in urejanje sta rezervirana za skrbnike podjetja. Izdani vmesnik se nato lahko sproži s strani vseh članov podjetja.

Kakšna je razlika med "Ping" in "Zahtevek testa"?

Ping samo preverja, ali je naslov dosegljiv — brez žetona in brez podatkov. Zahtevek testa pošlje vzorčne podatke vključno z žetonom in prikazuje celoten odgovor.

Je moj API žeton varen?

Da. Žeton je shranjen šifriran in nikoli se ne dostavi do odjemalcev. Aplikacija samo prikazuje, ali je žeton nastavljen in kdaj poteče.

Kateri naslovi so dovoljeni kot končne točke?

Samo javno dostopni naslovi https://. Notranji cilji kot localhost, zasebna omrežja ali oblačni metapodatki so zavrnjeni — to ščiti pred zlorabo vmesnika.

Zakaj ne morem več spremeniti izdanega vmesnika?

Izdani vmesniki so namerno nespremenljivi — tako da po izdaji nihče ne more zamenjati ciljnega naslova ali žetona. Za spremembe ustvarite novo različico.