GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.
Før du starter
- Du er ejer af arbejdsområdet eller redaktør. Læsere kan ikke oprette eller bruge en API-nøgle.
- Ejeren af arbejdsområdet har et aktivt abonnement.
Opret din API-nøgle
1
Åbn dine kontoindstillinger
Åbn dine kontoindstillinger, og gå til API.
2
Generér nøglen
Klik på Generate API key.
3
Kopiér nøglen
Vis nøglen, og kopiér den. Nøgler starter med
sk_live_.Godkend forespørgsler
Send nøglen som Bearer-token iAuthorization-headeren i hver forespørgsel:
Statustjekket er det eneste endepunkt, der virker uden nøgle.
Adgang og roller
- Roller. Kun ejeren af arbejdsområdet og redaktører kan oprette og bruge en API-nøgle. Læsere kan ikke.
- Arbejdsområde. Hver nøgle hører til ét arbejdsområde, og hver forespørgsel kører i det arbejdsområde. Du behøver ikke angive et arbejdsområde-id.
- Løbende tjek. Adgangen tjekkes ved hver forespørgsel ud fra din nuværende rolle og abonnementet hos ejeren af arbejdsområdet. Dit eget abonnement tæller ikke. Hvis din rolle ændres til læser, eller ejerens abonnement udløber, returnerer forespørgsler
403, indtil adgangen er genoprettet. Du behøver ikke en ny nøgle. - Fjernelse. Hvis du bliver fjernet fra arbejdsområdet, slettes din API-nøgle. Hvis du bliver tilføjet igen, skal du generere en ny nøgle.
Generér en ny nøgle
Generér en ny nøgle, hvis den er lækket, eller hvis nogen, der ikke burde have den, har fået adgang til den.1
Klik på Regenerate
Gå til API i dine kontoindstillinger, og klik på Regenerate.
2
Bekræft
Klik på Regenerate key.
3
Opdater dine apps
Kopiér den nye nøgle, og erstat den gamle alle de steder, du bruger den.
Pas godt på din nøgle
Behandl nøglen som en adgangskode: Alle, der har den, kan oprette, ændre og slette QR-koder i dit arbejdsområde.- Gem den i en miljøvariabel eller en secrets manager, ikke i kildekoden.
- Kald kun API’et fra din server. Læg aldrig nøglen i et website, en mobilapp eller noget andet, brugere kan inspicere.
- Del den kun med udviklere, der har brug for den.
- Generér en ny nøgle, så snart du har mistanke om, at den er lækket.
Almindelige problemer
Jeg får 401 med en nøgle, der plejede at virke
Jeg får 401 med en nøgle, der plejede at virke
Der er genereret en ny nøgle, eller du er blevet fjernet fra arbejdsområdet, og nøglen er slettet. Kopiér den aktuelle nøgle fra dine kontoindstillinger, eller generér en ny.
Jeg får 403 ved hver forespørgsel
Jeg får 403 ved hver forespørgsel
Tjek, at din rolle er ejer eller redaktør, og at abonnementet hos ejeren af arbejdsområdet er aktivt. Nøglen virker igen, så snart adgangen er genoprettet.
Jeg får 404 "This endpoint is not available."
Jeg får 404 "This endpoint is not available."
API’et er i beta og er endnu ikke slået til for dit arbejdsområde.
Jeg kan ikke se API-indstillingerne
Jeg kan ikke se API-indstillingerne
De vises kun for ejeren af arbejdsområdet og redaktører og kun i arbejdsområder, hvor API’et er slået til.