Hoppa till huvudinnehåll
GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
GetQR:s API autentiserar varje begäran med kontots API-nyckel. Varje användare har en nyckel, och den agerar som du i en arbetsyta.

​
Innan du börjar

  • Du är arbetsytans ägare eller redigerare. Läsare kan inte skapa eller använda en API-nyckel.
  • Arbetsytans ägare har en aktiv prenumeration.

​
Skapa din API-nyckel

1

Öppna kontoinställningarna

Öppna kontoinställningarna och gå till API.
2

Generera nyckeln

Klicka på Generate API key.
3

Kopiera nyckeln

Visa nyckeln och kopiera den. Nycklar börjar med sk_live_.
Du kan visa och kopiera nyckeln igen när som helst. Inställningarna visar också när nyckeln skapades och när den senast användes.

​
Autentisera begäranden

Skicka nyckeln som Bearer-token i Authorization-huvudet i varje begäran:
Statuskontrollen är den enda slutpunkten som fungerar utan nyckel.

​
Åtkomst och roller

  • Roller. Bara arbetsytans ägare och redigerare kan skapa och använda en API-nyckel. Läsare kan inte det.
  • Arbetsyta. Varje nyckel hör till en enda arbetsyta, och varje begäran körs i den arbetsytan. Du behöver inte skicka något arbetsyte-id.
  • Löpande kontroller. Åtkomsten kontrolleras vid varje begäran mot din nuvarande roll och arbetsytans ägares prenumeration. Din egen prenumeration spelar ingen roll. Om din roll ändras till läsare eller ägarens prenumeration upphör returnerar begäranden 403 tills åtkomsten är återställd. Du behöver ingen ny nyckel.
  • Borttagning. Om du tas bort från arbetsytan raderas din API-nyckel. Om du läggs till igen genererar du en ny nyckel.

​
Generera om nyckeln

Generera om nyckeln om den läcker eller om någon som inte borde ha den får tillgång till den.
Den nuvarande nyckeln slutar fungera direkt. Appar och integrationer som använder den slutar fungera tills du uppdaterar dem med den nya nyckeln.
1

Klicka på Regenerate

Gå till API i kontoinställningarna och klicka på Regenerate.
2

Bekräfta

Klicka på Regenerate key.
3

Uppdatera dina appar

Kopiera den nya nyckeln och ersätt den gamla överallt där du använder den.

​
Skydda din nyckel

Behandla nyckeln som ett lösenord: alla som har den kan skapa, ändra och ta bort QR-koder i din arbetsyta.
  • Spara den i en miljövariabel eller en hemlighetshanterare, inte i källkoden.
  • Anropa API:et bara från din server. Lägg aldrig nyckeln i en webbplats, en mobilapp eller något annat som användare kan granska.
  • Dela den bara med utvecklare som behöver den.
  • Generera om den så fort du misstänker att den har läckt.

​
Vanliga problem

Nyckeln har genererats om, eller så har du tagits bort från arbetsytan och nyckeln har raderats. Kopiera den aktuella nyckeln från kontoinställningarna eller generera en ny.
Kontrollera att din roll är ägare eller redigerare och att arbetsytans ägare har en aktiv prenumeration. Nyckeln fungerar igen så fort åtkomsten är återställd.
API:et är i beta och är inte aktiverat för din arbetsyta än.
De visas bara för arbetsytans ägare och redigerare, och bara i arbetsytor där API:et är aktiverat.

​
Nästa steg

Introduktion till API:et

Fel