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.

Egna element: API

Ett API-gränssnitt är ett formulär vars fyllda värden Skava skickar som JSON till en adress Du anger (Din server). På så sätt kan Du ansluta Skava säkert med Dina egna system.

Du hanterar API-gränssnitt i Webappen under Egna element → växla API-gränssnitt. Skapande och redigering är reserverat för företagsadministratörer; lanserade gränssnitt kan sedan utlösas av alla medlemmar i företaget.

Ställ upp ett API-gränssnitt

Ett gränssnitt består av inmatningsfält (de bildar JSON), måladress och autentisering.

Skapa fält: Varje fält får en JSON-nyckel. Till höger ser Du live JSON-förhandsvisningen, som skickas till Din server på exakt detta sätt.
Adress (URL): https://-adressen för Din server. Endast HTTPS- och offentligt tillgängliga adresser tillåts (se Säkerhet nedan).
Metod: POST (standard), PUT, PATCH eller GET. Med GET läggs värdena till som frågeparametrar istället för att skickas i kroppen.
Autentisering: Ställ in rubriknamnet (t.ex. Authorization) och värdeprefixet (t.ex. Bearer ), spara sedan token. Ställ alternativt in ett utgångsdatum.
Svarsfeld (valfritt): Definiera efter väg vilka värden från serverns svar som ska visas — t.ex. order.id eller items[0].sku.
Kontrollera med Ping och Testbegäran, sedan Lansera.

Lagra token säkert

Token lagras krypterad och returneras aldrig till klienter — appen visar bara om en token är inställd och när den upphör. Vid sändning, Skava lägger den till servern till den konfigurerad rubriken. Om Du ställer in ett utgångsdatum, Skava vägrar anropet efter utgång och ber Dig förnya token.

Testning: Ping och testbegäran

Ping — en lätt nåbarhetskontroll. Det kontrollerar bara om Din adress svarar och skickar inte token eller formulärdata under processen. Visar nåbarhet, status och svarstid. Idealisk som ett första steg.
Testbegäran — den riktiga testkörningen: skickar exempeldata inklusive token till Din adress och visar Du det kompletta svaret såväl som de extraherad svarsfälten.

Som administratör kan Du köra båda medan Du fortfarande är i utkastläge för att verifiera integreringen innan lansering.

Utkast och lansering

Varje gränssnitt startar som ett utkast och kan redigeras fritt. När allt är klart, lanserar Du det med Lansera.

Lanserade gränssnitt är oföränderliga. Detta är avsiktligt: så att ingen kan hemligt byta måladress eller token efter lansering. Om Du vill ändra något, skapa en ny version.

Säkerhet

För att förhindra att gränssnittet missbrukas gäller strikt regler: endast HTTPS-adresser tillåts, och adressen måste peka till en offentlig måladress — interna adresser (t.ex. localhost, privata nätverk eller moln-metadata) avvisas. Skava kontrollerar detta vid varje samtal, ansluter exakt till den verifierad adressen, följer inga omdirigeringar och begränsar timeout och svarsstorlek.

Relaterat

Vill Du istället bygga en fyllig dokumentmall? Se Egna element: Dokument.

Vanliga frågor

Vad är ett API-gränssnitt i Skava?

Ett formulär vars fyllda värden Skava skickar som JSON till en adress Du anger (Din server) — praktisk för att ansluta Skava med Dina egna system.

Vem får skapa och utlösa API-gränssnitt?

Skapande och redigering är reserverat för företagsadministratörer. Ett lanserat gränssnitt kan sedan utlösas av alla medlemmar i företaget.

Vad är skillnaden mellan "Ping" och "Testbegäran"?

Ping kontrollerar bara om adressen är nåbar — utan token och utan data. Testbegäran skickar exempeldata inklusive token och visar det kompletta svaret.

Är min API-token säker?

Ja. Token lagras krypterad och levereras aldrig till klienter. Appen visar bara om en token är inställd och när den upphör.

Vilka adresser är tillåtna som slutpunkter?

Endast offentligt tillgängliga https://-adresser. Interna mål som localhost, privata nätverk eller moln-metadata avvisas — detta skyddar mot missbruk av gränssnittet.

Varför kan jag inte längre ändra ett lanserat gränssnitt?

Lanserade gränssnitt är avsiktligt oföränderliga — så att ingen kan byta måladress eller token efter lansering. För ändringar skapar Du en ny version.