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.

Elementë të Veçantë: API

Një interfse API është një formë vlerat e plotësuara të cilës Skava dërgon si JSON në një adresë që specifikon (backend-in tuaj). Në këtë mënyrë mund të lidhësh Skava në mënyrë të sigurt me sistemet tuaja.

Menaxhon interfset API në Aplikacionin Web nën Elementët e Veçantë → ndërruesi Interfset API. Krijimi dhe redaktimi janë të rezervuar për administratorët e kompanisë; interfset e lëshuar mund të aktivizohen nga të gjithë anëtarët e kompanisë.

Vendosja e një interfse API

Një interfse përbëhet nga fushat e hyrjes (ato formojnë JSON-in), adresa e destinacionit dhe autentifikimin.

Krijoni fushat: Çdo fushë merr një çelës JSON. Në të djathtë sheh në direkt parashikimin JSON, e cila dërgohet në backend-in tuaj në këtë saktësi.
Adresa (URL): adresa https:// e backend-it tuaj. Vetëm adreset HTTPS dhe të arritshme publike janë të lejuara (shiko Siguria më poshtë).
Metoda: POST (parazgjedhje), PUT, PATCH ose GET. Me GET vlerat shtohen si parametra kërkimi në vend të të dërgimit në trup.
Autentifikimi: Vendosë emrin e kokës (p.sh. Autorizimi) dhe parashtesën e vlerës (p.sh. Mbajtës ), më pas ruaj token-in. Opsionalisht vendosë një datë skadimi.
Fushat e përgjigjes (opsionale): Përcakto sipas shtegut cilat vlera nga përgjigja e backend-it duhet të shfaqen — p.sh. porosisë.id ose artikujt[0].sku.
Kontrolloji me Pingsje dhe Kërkesë Testi, më pas Lësho.

Ruaj token në mënyrë të sigurt

Token-i ruhet i enkriptuar dhe kurrë nuk u kthehet klientëve — aplikacioni vetëm tregon nëse është vendosur një token dhe kur skadon. Kur dërgohen, Skava e shtojnë atë në kokën e konfiguruar në anën e serverit. Nëse vendosësh një datë skadimi, Skava refuzon thirrjen pas skadimit dhe të kërkon të përbartheësh token-in.

Testimi: Pingsje dhe Kërkesë Testi

Pingsje — një kontroll i lehtë i arritshmerisë. Ajo vetëm kontrollon nëse adresa juaj përgjigjet dhe nuk dërgon token-in ose të dhënat e formës në procesin. Tregon arritshmerinë, statusin dhe kohën e përgjigjes. Ideal si një hap i parë.
Kërkesë Testi — provimi i vërtetë: dërgon të dhënat e mostrës përfshirë token-in në adresën tuaj dhe të tregon përgjigjen e plotë si dhe fushat e përgjigjes të nxjerrë.

Si administrim, mund të ekzekutosh të dyja ndërsa ende në mënyrën skice për të verifikuar integrimin para lëshimit.

Skica dhe Lëshim

Çdo interfse fillon si një skicë dhe mund të redaktohet lirshëm. Kur gjithçka është gata, lësho atë me Lësho.

Interfset e lëshuar janë të palëvizshme. Ky është qëllimor: kështu që pas lëshimit ndonjë nuk mund të ndërrojë në mënyrë të fshehtë adresën e destinacionit ose token-in. Nëse dëshiron të ndryshosh diçka, krijo një version të ri.

Siguria

Për të parandaluar keqpërdorimin e interfset, zbatohen rregulla strikte: vetëm adreset HTTPS lejohen dhe adresa duhet të tregojë në një adresë të destinacionit publike — adreset e brendshme (p.sh. localhost, rrjetat private ose metapodatat cloud) refuzohen. Skava kontrollon këtë në çdo thirrje, lidhet saktërisht me adresën e verifikuar, nuk ndjek ridirektim dhe kufizon kohën e mbetur dhe madhësinë e përgjigjes.

I Lidhur

Dëshiron të ndërto një shablone dokumenti të plotësueshme në vend? Shiko Elementë të Veçantë: Dokumentet.

Pyetjet e Shpeshta

Çfarë është një interfse API në Skava?

Një formë vlerat e plotësuara të cilës Skava dërgon si JSON në një adresë që specifikon (backend-in tuaj) — i dobishëm për lidhjen e Skava me sistemet tuaja të veta.

Kush lejohet të krijon dhe aktivizoj interfset API?

Krijimi dhe redaktimi janë të rezervuar për administratorët e kompanisë. Një interfse i lëshuar mund të aktivizohet nga të gjithë anëtarët e kompanisë.

Cili është ndryshimi midis "Pingsje" dhe "Kërkesë Testi"?

Pingsje vetëm kontrollon nëse adresa është e arritshme — pa token dhe pa të dhëna. Kërkesë Testi dërgon të dhënat e mostrës përfshirë token-in dhe tregon përgjigjen e plotë.

A është token-i im API i sigurt?

Po. Token-i ruhet i enkriptuar dhe kurrë nuk dërgohet në klientë. Aplikacioni tregon vetëm nëse është vendosur një token dhe kur skadon.

Cilat adresa lejohen si skaje?

Vetëm adreset https:// të arritshme publike. Objektet e brendshme si localhost, rrjetat private ose metapodatat cloud refuzohen — kjo mbron kundër keqpërdorimit të interfset.

Pse nuk mund të ndryshoj një interfse të lëshuar më?

Interfset e lëshuar janë qëllimisht të palëvizshme — kështu që pas lëshimit ndonjë nuk mund të ndërrojë adresën e destinacionit ose token-in. Për ndryshime, krijoni një version të ri.