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.

pasirinktiniai elementai: API

API sąsaja yra forma, kurios užpildytos reikšmės Skava siunčia kaip JSON į jūs nurodytą adresą (jūsų sistemą). tokiu būdu jūs galite saugiai sujungti Skava su jūsų sistema.

Jūs tvarkote API sąsajas žiniatinklio programoje po pasirinktiniai elementai → perjungti API sąsajos. Kūrimas ir redagavimas yra rezervuota dėl įmonės administratoriai; išleisti sąsajos gali būti suaktyvinti visi įmonės nariai.

Sąranka API sąsajos

Sąsaja susideda iš įvesties laukų (jie formos JSON), tikslo adreso, ir autentifikavimo.

Kurkite laukus: Kiekvienas laukas gauna JSON raktą. dešinėje jūs žiūrite gyvas JSON peržiūra, kuri yra siunčiama jūsų sistemai tiksliai tokiu būdu.
adresas (URL): https:// jūsų sistemos adresas. tik HTTPS ir viešai pasiekiami adresai yra leistini (žr. saugumą žemiau).
metodas: POST (numatytas), PUT, PATCH, arba GET. su GET reikšmės yra pridėtas kaip užklausos parametrai vietoj to, jei siunčiami kūne.
autentifikavimas: Nustatykite antraštės pavadinimą (pvz. autorizacija) ir reikšmės priešdėlį (pvz. nešlys ), tada išsaugoti žetoną. pasirinktinai nustatykite galiojimo datą.
atsakymo laukai (pasirinktinai): Nurodykite pagal kelią, kurios reikšmės iš sistemos atsakymo turėtų būti parodyta - pvz. užsakymas.identifikatorius arba elementai[0].sku.
Patikrinkite su bang ir bandomoji užklausa, tada išleisti.

saugiai saugoti žetoną

žetonas yra saugomas šifruotas ir niekada negrąžinti klientams - programa tik rodo ar žetonas nustatytas ir kada baigiasi. siunčiant, Skava pridengia jį serveryje nurodytą antraštę. Jei nustatysite galiojimo datą, Skava atmeta skambučio po galiojimo ir prašo atnaujinti žetoną.

bandymas: bang ir bandomoji užklausa

bang - lengvas pasiekiamumo patikrinimas. jis tik patikrina ar jūsų adresas atsakinėja, ir nedaro žetoną ar formos duomenis procese. rodo pasiekiamumą, statusą ir atsakymo laiką. idealu kaip pirmas žingsnis.
bandomoji užklausa - tikrosios bandymo bėgyje: siunčia pavyzdiniai duomenys, įskaitant žetoną jūsų adresą ir rodo jums pilną atsakymą, taip pat išsaugotus atsakymo laukus.

kaip administratorius, jūs galite bėgti ir tol, kol jūs vis dar juodraščio režime patikrinti integravimą prieš išleidimą.

juodraštis ir išleidimas

Kiekviena sąsaja pradeda kaip juodraštis ir gali būti laisvai redaguojama. kai viskas paruošta, jūs išleidžiate jį su išleisti.

Išleisti sąsajos yra nekintami. tai yra tikslas: kad po išleidimo niekas negali slapčiai pasikeisti tikslo adresą arba žetoną. Jei norite ką nors pakeisti, sukurkite naują versiją.

saugumas

Saugoti sąsaja nuo sufisumo naudojimo, griežtos taisyklės taikomos: tik HTTPS adresai yra leistini, ir adresas turi nukreipti į viešą tikslo adresą - vidiniai adresai (pvz. localhost, privates tinklai, arba debesies metaduomenys) yra atmesti. Skava tai patikrina kiekviename skambučio, tiesiogiai susieja su patikrinti adresu, neatlieka peradresavimų ir riboja laiko išeigą ir atsakymo dydį.

susiję

Jei vietoj jūs norėtumėte kurti užpildytą dokumentų šabloną? Žr. pasirinktiniai elementai: dokumentai.

dažnai užduodami klausimai

kas yra API sąsaja Skava?

forma, kurios užpildytos reikšmės Skava siunčia kaip JSON į adresą jūs nurodote (jūsų sistemą) - patarimas dėl jungimo Skava su jūsų sistema.

kas gali kurti ir suaktyvinti API sąsajas?

Kūrimas ir redagavimas yra rezervuota dėl įmonės administratoriai. išleistą sąsajos gali būti suaktyvinti visi įmonės nariai.

kas yra skirtumas tarp "bang" ir "bandomoji užklausa"?

bang tik patikrina ar adresas pasiekiamas - be žetono ir be duomenų. bandomoji užklausa siunčia pavyzdiniai duomenys, įskaitant žetoną ir rodo pilną atsakymą.

ar mano API žetonas saugus?

taip. žetonas yra saugomas šifruotas ir niekada nepristatytas klientams. programa tik rodo ar žetonas nustatytas ir kada baigiasi.

kurie adresai leistini kaip galiniai taškai?

tik viešai pasiekiami https:// adresai. vidiniai tikslai, tokia localhost, privates tinklai, arba debesies metaduomenys yra atmesti - tai apsaugoti nuo sąsajos sufisumo naudojimo.

kodėl negaliu keisti išleistos sąsajos?

Išleisti sąsajos yra tikslas nekintami - kad po išleidimo niekam negali pasikeisti tikslo adresą arba žetoną. dėl pakeitimų, sukurkite naują versiją.