Brugerdefinerede elementer: API
En API-grænseflade er en form hvis fyldt værdier Skava sender som JSON til en adresse du angiver (dit backend). På denne måde kan du forbinde Skava sikkert med dine egne systemer.
Du administrerer API-grænseflader i Webappen under Brugerdefinerede elementer → skift API-grænseflader. Oprettelse og redigering er forbeholdt virksomhedsadministratorer; frigivet grænseflader kan så bruges af alle medlemmer af virksomheden.
Opsæt en API-grænseflade
En grænseflade består af inputfelter (de danner JSON'en), måldomænen og autentifikation.
- Opret felter: Hvert felt får en JSON-nøgle. Til højre ser du live JSON-forhåndsvisningen som sendes til dit backend nøjagtigt sådan.
- Adresse (URL):
https://-adressen på dit backend. Kun HTTPS og offentligt tilgængelige adresser er tilladt (se sikkerhed nedenfor). - Metode:
POST(standard),PUT,PATCHellerGET. MedGETtilføjes værdierne som forespørgselsparametre i stedet for at blive sendt i brødteksten. - Autentifikation: Angiv headernavn (f.eks.
Authorization) og værdiforstavelse (f.eks.Bearer), gem derefter token. Valgfrit sæt en udløbsdato. - Svarf felter (valgfrit): Definer efter sti hvilke værdier fra backend-svaret skal vises — f.eks.
order.idelleritems[0].sku. - Tjek med Ping og Test anmodning, derefter Frigiv.
Gem token sikkert
Token'et gemmes krypteret og returneres aldrig til klienter — appen viser kun om et token er indstillet og hvornår det udløber. Ved sending tilføjer Skava det server-siden til den konfigurerede header. Hvis du sætter en udløbsdato, nægter Skava opkaldet efter udløb og beder dig om at fornye token'et.
Test: Ping og testanmodning
- Ping — en let tilgængeligheds-tjek. Den tjekker kun om din adresse svarer, og sender ikke token eller formular-data i processen. Viser tilgængelighed, status og svar-tid. Ideelt som første skridt.
- Test anmodning — prøvekørslen: sender eksempel data inklusiv token til din adresse og viser dig det komplette svar samt de ekstraherede svarfelter.
Som administrator kan du køre begge mens stadig i udkasts tilstand for at verificere integration før frigivelse.
Udkast og frigivelse
Hver grænseflade starter som et udkast og kan redigeres frit. Når alt er klart, frigiver du det med Frigiv.
Frigivet grænseflader er uforanderlige. Dette er med vilje: så ingen kan hemmeligt skifte måldomæne eller token efter frigivelse. Hvis du vil ændre noget, opret en ny version.
Sikkerhed
For at forhindre grænsefladen i at blive misbrugt gælder strenge regler: kun HTTPS-adresser er tilladt, og adressen skal pege på et offentligt mål — interne adresser (f.eks. localhost, private netværk eller cloud metadata) afvises. Skava tjekker dette ved hver opkald, forbinder nøjagtigt til den verificerede adresse, følger ingen videresendinger og begrænser timeout og svar-størrelse.
Relateret
Vil du i stedet bygge en udfyldbar dokumentskabelon? Se Brugerdefinerede elementer: Dokumenter.
Ofte stillede spørgsmål
Hvad er en API-grænseflade i Skava?
En form hvis fyldt værdier Skava sender som JSON til en adresse du angiver (dit backend) — praktisk til at forbinde Skava med dine egne systemer.
Hvem har tilladelse til at oprette og udløse API-grænseflader?
Oprettelse og redigering er forbeholdt virksomhedsadministratorer. En frigivet grænseflade kan så udløses af alle medlemmer af virksomheden.
Hvad er forskellen mellem "Ping" og "Test anmodning"?
Ping tjekker kun om adressen er tilgængelig — uden token og uden data. Test anmodning sender eksempel-data inklusiv token og viser det komplette svar.
Er mit API-token sikker?
Ja. Token'et gemmes krypteret og leveres aldrig til klienter. Appen viser kun om et token er indstillet og hvornår det udløber.
Hvilke adresser er tilladt som endpoints?
Kun offentligt tilgængelige https://-adresser. Interne mål som localhost, private netværk eller cloud metadata afvises — dette beskytter mod misbrug af grænsefladen.
Hvorfor kan jeg ikke ændre en frigivet grænseflade længere?
Frigivet grænseflader er med vilje uforanderlige — så ingen kan hemmeligt skifte måldomæne eller token efter frigivelse. For ændringer opret du en ny version.