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.

Custom Elements: API

API liides on vorm, mille täidetud väärtused Skava saadab JSON-formaadis teie määratud aadressile (teie backend). Sel viisil saate Skava oma süsteemidega turvaliselt ühendada.

API liideste haldamist teete Webappis jaotises Custom Elements → vahetage API Liideste sisse/välja. Loomine ja muutmine on reserveeritud ettevõtte administraatorite jaoks; väljaantud liideste saavad seejärel käivitada kõik ettevõtte liikmed.

API liidese seadistamine

Liides koosneb sisendväljadest (need moodustavad JSON-i), sihtaadressist ja autentimisest.

Luua väljad: Iga väli saab JSON võtme. Paremal näete reaalajas JSON eelvaadet, mis saadetakse teie backendile täpselt sel viisil.
Aadress (URL): teie backend'i https:// aadress. Lubatud on ainult HTTPS ja avalikult ligipääsetavad aadressid (vt alljärgneva turvalisuse osa).
Meetod: POST (vaikimisi), PUT, PATCH või GET. GET puhul lisatakse väärtused päringutena URL-i parameetrite kujul, mitte kehas saadetud kujul.
Autentimine: Määrake päise nimi (nt Authorization) ja väärtuse eesliide (nt Bearer ), seejärel salvestage token. Soovi korral määrake aegumiskuupäev.
Vastuseväljad (valikuline): Määrake tee järgi, millised väärtused backend'i vastusest tuleks kuvada — nt order.id või items[0].sku.
Kontrollige Ping ja Testkutsega, seejärel Avaldage.

Token turvaline salvestamine

Token on salvestatud krüpteeritud kujul ja ei tagastata kunagi klientidele — rakendus näitab ainult kas token on seatud ja millal see aegub. Saatmisel lisab Skava selle serveri poolest seadistatud päisele. Kui määrate aegumiskuupäeva, keeldub Skava kutsest pärast aegumist ja palub teil tokeni uuendada.

Testimine: Ping ja Testkutse

Ping — kerge saavutatavuse kontroll. See kontrollib ainult kas teie aadress vastab, ja ei saada protsessis tokenit ega vormiandmeid. Näitab saavutatavust, staatust ja vastuse aega. Ideaalne esimese sammuna.
Testkutse — proovikahe tegelik käik: saadab näidisandmed koos tokeniga teie aadressile ja näitab teile terviklikku vastust ning ekstraheeritud vastuseväljasid.

Administraatorina saate käivitada mõlemad isegi mustandis olles, et kontrollida integratsioon enne avaldamist.

Mustand ja Avaldamine

Iga liides algab mustandina ja seda saab vabalt muuta. Kui kõik on valmis, avaldage see Avaldamise kaudu.

Avaldatud liideste ei saa muuta. See on tahtlik: et pärast avaldamist ei saaks keegi salaja sihtaadressi ega tokenit vahetada. Kui tahate midagi muuta, looge uus versioon.

Turvalisus

Liidese kuritarvitamise vältimiseks kehtivad ranged reeglid: lubatud on ainult HTTPS aadressid ja aadress peab osutama avalikule sihtkohale — sisemised aadressid (nt localhost, privaatse võrgu aadressa või pilvemetaandmeid) lükatakse tagasi. Skava kontrollib seda iga kutse korral, ühendub täpselt kontrollitud aadressiga, ei järgi ümbersuunamisi ja piirab ajalõppe ning vastuse suurust.

Seotud

Kas tahate pigem ehitada täidetavat dokumentide malli? Vt Custom Elements: Dokumendid.

Korduma Kippuvad Küsimused

Mis on Skava-s API liides?

Vorm, mille täidetud väärtused Skava saadab JSON-formaadis teie määratud aadressile (teie backend) — kasulik Skava ühendamiseks oma süsteemidega.

Kes tohib luua ja käivitada API liideste?

Loomine ja muutmine on reserveeritud ettevõtte administraatorite jaoks. Avaldatud liidest saavad seejärel käivitada kõik ettevõtte liikmed.

Mis on erinevus "Pingi" ja "Testkutse" vahel?

Ping kontrollib ainult, kas aadress on saavutatav — ilma tokenita ja ilma andmeteta. Testkutse saadab näidisandmed koos tokeniga ja näitab terviklikku vastust.

Kas minu API token on turvaline?

Jah. Token on salvestatud krüpteeritud kujul ja ei toimitata kunagi klientidele. Rakendus näitab ainult, kas token on seatud ja millal see aegub.

Millised aadressid on lubatud lõpp-punktidena?

Ainult avalikult ligipääsetavad https:// aadressid. Sisemised sihtkohad nagu localhost, privaatne võrk või pilvemetaandmed lükatakse tagasi — see kaitseb liidese kuritarvitamise eest.

Miks ei saa ma enam avaldatud liidest muuta?

Avaldatud liideste ei saa tahtlikult muuta — et pärast avaldamist ei saaks keegi sihtaadressi ega tokenit vahetada. Muutuste jaoks loote uue versiooni.