Skava Skava / Wiki

Egendefinerte elementer: API

Et API-grensesnitt er et skjema hvis fylte verdier Skava sender som JSON til en adresse du angir (din backend). Slik kan du koble Skava sikkert med dine egne systemer.

i

Du administrerer API-grensesnitt i nettappen under Egendefinerte elementer → veksl API-grensesnitt. Oppretting og redigering er reservert firmaadministratorer; frigitte grensesnitt kan deretter utløses av alle medlemmer i firmaet.

Sett opp et API-grensesnitt

Et grensesnitt består av inputfelt (de danner JSON-en), måladressen og autentisering.

  1. Opprett felt: Hvert felt får en JSON-nøkkel. På høyre side ser du live JSON-forhåndsvisningen, som sendes til backend-en nøyaktig på denne måten.
  2. Adresse (URL): https://-adressen til backend-en. Bare HTTPS og offentlig tilgjengelige adresser er tillatt (se Sikkerhet nedenfor).
  3. Metode: POST (standard), PUT, PATCH eller GET. Med GET blir verdiene lagt til som spørringsparametere i stedet for sendt i kroppen.
  4. Autentisering: Angi hodenavn (f.eks. Autorisasjon) og verdiprefiksk (f.eks. Bærer ), deretter lagre tokenet. Angi eventuelt utløpsdato.
  5. Svarfelt (valgfritt): Definer etter sti hvilke verdier fra backend-svaret som skal vises – f.eks. ordre.id eller elementer[0].sku.
  6. Sjekk med Ping og Test-forespørsel, deretter Frigi.

Lagre token sikkert

Tokenet lagres kryptert og blir aldri returnert til klienter – appen viser bare hvorvidt et token er satt og når det utløper. Ved sending legger Skava det til serveren til den konfigurerte overskriften. Hvis du angir utløpsdato, vil Skava nekte samtalen etter utløp og be deg fornye tokenet.

Testing: Ping og test-forespørsel

  • Ping – en lett nåbarhetssjekk. Den sjekker bare hvorvidt adressen responderer, og sender ikke token eller skjemadata i prosessen. Viser nåbarhet, status og responstid. Ideelt som første steg.
  • Test-forespørsel – den virkelige testprøven: sender eksempeldata inkludert token til adressen og viser deg det komplette svaret samt de uttalte svarfeltene.

Som admin kan du kjøre begge mens fortsatt i utkastmodus for å bekrefte integrasjonen før frigjøring.

Utkast og frigjøring

Hvert grensesnitt starter som et utkast og kan redigeres fritt. Når alt er klart, frigjør du det med Frigi.

!

Frigitte grensesnitt er uforanderlige. Dette er bevisst: slik at ingen etter frigjøring kan hemlig bytte måladressen eller tokenet. Hvis du vil endre noe, oppretter du en ny versjon.

Sikkerhet

i

For å forhindre at grensesnittet blir misbrukt, gjelder strenge regler: bare HTTPS-adresser er tillatt, og adressen må peke på en offentlig måladresse – interne adresser (f.eks. localhost, private nettverk eller sky-metadata) blir avvist. Skava sjekker dette ved hver samtale, kobler nøyaktig til den verifiserte adressen, følger ingen viderekobinger og begrenser tidsavbrytelse og responsstørrelse.

Relatert

Vil du i stedet bygge en fylbar dokumentmal? Se Egendefinerte elementer: Dokumenter.

Ofte stilte spørsmål

Hva er et API-grensesnitt i Skava?

Et skjema hvis fylte verdier Skava sender som JSON til en adresse du angir (din backend) – praktisk for å koble Skava med dine egne systemer.

Hvem har tillatelse til å opprette og utløse API-grensesnitt?

Oppretting og redigering er reservert firmaadministratorer. Et frigitt grensesnitt kan deretter utløses av alle medlemmer i firmaet.

Hva er forskjellen mellom "Ping" og "Test-forespørsel"?

Ping sjekker bare hvorvidt adressen er nåbar – uten token og uten data. Test-forespørsel sender eksempeldata inkludert token og viser det komplette svaret.

Er API-tokenet mitt sikkert?

Ja. Tokenet lagres kryptert og blir aldri levert til klienter. Appen viser bare hvorvidt et token er satt og når det utløper.

Hvilke adresser er tillatt som endepunkter?

Bare offentlig tilgjengelige https://-adresser. Interne mål som localhost, private nettverk eller sky-metadata blir avvist – dette beskytter mot misbruk av grensesnittet.

Hvorfor kan jeg ikke lenger endre et frigitt grensesnitt?

Frigitte grensesnitt er bevisst uforanderlige – slik at ingen etter frigjøring kan bytte måladressen eller tokenet. For endringer oppretter du en ny versjon.