Hopp til hovedinnhold
GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
GetQR API-et autentiserer hver forespørsel med API-nøkkelen til kontoen din. Hver bruker har én nøkkel, og den handler på dine vegne i ett arbeidsområde.

Før du starter

  • Du er eieren av arbeidsområdet eller redaktør. Lesere kan ikke opprette eller bruke en API-nøkkel.
  • Eieren av arbeidsområdet har et aktivt abonnement.

Opprett API-nøkkelen din

1

Åpne kontoinnstillingene

Åpne kontoinnstillingene dine og gå til API.
2

Generer nøkkelen

Klikk Generate API key.
3

Kopier nøkkelen

Vis nøkkelen og kopier den. Nøkler starter med sk_live_.
Du kan når som helst vise og kopiere nøkkelen igjen. Innstillingene viser også når nøkkelen ble opprettet og når den sist ble brukt.

Autentiser forespørsler

Send nøkkelen som Bearer-token i Authorization-headeren i hver forespørsel:
Statussjekken er det eneste endepunktet som fungerer uten nøkkel.

Tilgang og roller

  • Roller. Bare eieren av arbeidsområdet og redaktører kan opprette og bruke en API-nøkkel. Lesere kan ikke det.
  • Arbeidsområde. Hver nøkkel tilhører ett enkelt arbeidsområde, og hver forespørsel kjøres i det arbeidsområdet. Du trenger ikke sende noen ID for arbeidsområdet.
  • Løpende kontroll. Tilgangen sjekkes ved hver forespørsel ut fra din nåværende rolle og abonnementet til eieren av arbeidsområdet. Ditt eget abonnement teller ikke. Hvis rollen din endres til leser, eller eierens abonnement avsluttes, returnerer forespørsler 403 til tilgangen er gjenopprettet. Du trenger ikke en ny nøkkel.
  • Fjerning. Hvis du fjernes fra arbeidsområdet, slettes API-nøkkelen din. Blir du lagt til igjen, genererer du en ny nøkkel.

Generer nøkkelen på nytt

Generer nøkkelen på nytt hvis den lekker, eller hvis noen som ikke skal ha den, får tilgang til den.
Den nåværende nøkkelen slutter å fungere med en gang. Alle apper og integrasjoner som bruker den, slutter å virke til du oppdaterer dem med den nye nøkkelen.
1

Klikk Regenerate

Gå til API i kontoinnstillingene og klikk Regenerate.
2

Bekreft

Klikk Regenerate key.
3

Oppdater appene dine

Kopier den nye nøkkelen og erstatt den gamle overalt der du bruker den.

Hold nøkkelen trygg

Behandle nøkkelen som et passord: alle som har den, kan opprette, endre og slette QR-koder i arbeidsområdet ditt.
  • Lagre den i en miljøvariabel eller et verktøy for hemmeligheter, ikke i kildekoden.
  • Kall API-et bare fra serveren din. Legg aldri nøkkelen i et nettsted, en mobilapp eller noe annet som brukere kan inspisere.
  • Del den bare med utviklere som trenger den.
  • Generer den på nytt så snart du mistenker at den har lekket.

Vanlige problemer

Nøkkelen er generert på nytt, eller du ble fjernet fra arbeidsområdet og nøkkelen ble slettet. Kopier den gjeldende nøkkelen fra kontoinnstillingene, eller generer en ny.
Sjekk at rollen din er eier eller redaktør, og at abonnementet til eieren av arbeidsområdet er aktivt. Nøkkelen fungerer igjen så snart tilgangen er gjenopprettet.
API-et er i beta og er ennå ikke aktivert for arbeidsområdet ditt.
De vises bare for eieren av arbeidsområdet og redaktører, og bare i arbeidsområder der API-et er aktivert.

Neste steg

Introduksjon til API-et

Feil