Fejl

GetQR API’et er i beta og er tilgængeligt for udvalgte arbejdsområder. Detaljer kan ændre sig før den generelle udgivelse.

GetQR API’et bruger standard-HTTP-statuskoder. Vellykkede forespørgsler returnerer 2xx. Mislykkede forespørgsler returnerer 4xx eller 5xx med en JSON-body, der forklarer, hvad der gik galt.

Fejlformat

Alle fejl har samme form: en stabil kode, en læsbar besked og et link til beskrivelsen af koden.

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized: Invalid API key.",
    "doc_url": "https://getqr.com/account/api-docs#error-unauthorized"
  }
}

string

påkrævet

Stabil, maskinlæsbar fejlkode. Brug den i din kode i stedet for beskeden. Se Fejlkoder.

string

påkrævet

Læsbar beskrivelse af problemet. Ordlyden kan ændre sig.

string

påkrævet

Link til beskrivelsen af fejlkoden i API-dokumentationen i din GetQR-konto.

Fejlkoder

Kode	HTTP-status	Hvornår den opstår
`bad_request`	400	Forespørgslen er forkert udformet: body er ikke gyldig JSON, `Authorization`-headeren mangler præfikset `Bearer` , eller handlingen er ikke tilladt i ressourcens nuværende tilstand (f.eks. at annullere en bulk-oprettelse, der er færdig).
`unauthorized`	401	API-nøglen mangler eller er ugyldig, f.eks. fordi der er genereret en ny.
`forbidden`	403	Abonnementet hos ejeren af arbejdsområdet er ikke aktivt, eller din rolle i arbejdsområdet tillader ikke handlingen.
`exceeded_limit`	403	Du har nået en grænse i dit abonnement. På Single QR-abonnementet gælder det, når du opretter eller duplikerer en QR-kode, mens arbejdsområdet allerede har én, eller når du starter en bulk-oprettelse.
`not_found`	404	Ressourcen findes ikke eller er ikke i dit arbejdsområde, endepunktet findes ikke, eller API’et er ikke slået til for dit arbejdsområde.
`method_not_allowed`	405	Endepunktet findes, men accepterer ikke denne HTTP-metode. `Allow`-headeren viser de metoder, det accepterer.
`conflict`	409	Forespørgslen er i konflikt med eksisterende data: kortlinkets slug er optaget, en forespørgsel med samme `Idempotency-Key` er stadig i gang, en tidsplan overlapper en eksisterende, eller et bulk-arkiv er ikke klar endnu.
`invite_pending`	409	Du er inviteret til arbejdsområdet, men har ikke tilsluttet dig endnu. Forespørgsler med API-nøgle returnerer den ikke: Nøglens arbejdsområde er altid et, du er medlem af.
`invite_expired`	410	Din invitation til arbejdsområdet er udløbet. Forespørgsler med API-nøgle returnerer den ikke af samme grund.
`unprocessable_entity`	422	Body eller forespørgselsparametre bestod ikke valideringen. Beskeden nævner feltet, og hvad der er galt med det. Se Valideringsfejl.
`rate_limit_exceeded`	429	API-nøglen har brugt sine forespørgsler i det aktuelle vindue. Se Hastighedsgrænser.
`internal_server_error`	500	Noget gik galt hos os. Prøv igen senere, og kontakt support, hvis det bliver ved.

Valideringsfejl

Når body eller forespørgselsparametre ikke består valideringen, svarer API’et 422. Beskeden beskriver det første ugyldige felt som <issue>: <field>: <details>:

{
  "error": {
    "code": "unprocessable_entity",
    "message": "too_big: pageSize: Max page size is 100.",
    "doc_url": "https://getqr.com/account/api-docs#error-unprocessable_entity"
  }
}

Indlejrede felter bruger punktnotation, f.eks. link.url.

Håndter fejl

Forgren på error.code, ikke på error.message.
Prøv ikke 4xx-fejl igen uændret: Ret forespørgslen først. Undtagelserne er en 409 for en forespørgsel, der stadig er i gang, og 429.
Ved 429 skal du vente det antal sekunder, der står i Retry-After-headeren. Se Hastighedsgrænser.
Prøv 5xx-fejl igen med eksponentiel backoff.

Almindelige problemer

Hver forespørgsel returnerer 404 "This endpoint is not available."

API’et er i beta og er endnu ikke slået til for dit arbejdsområde.

404 "This endpoint does not exist."

Stien er forkert. Tjek den mod siderne for endepunkterne, og tjek, at den starter med /api/v1/.

403 "Access denied: This account does not have an active subscription."

Abonnementet hos ejeren af arbejdsområdet er udløbet. API-nøglen virker igen, så snart ejeren genoptager abonnementet.

403 "API access is not available for this role."

Din rolle i arbejdsområdet er læser. Kun ejeren af arbejdsområdet og redaktører kan bruge API’et.

API

Fejlformat

Fejlkoder

Valideringsfejl

Håndter fejl

Almindelige problemer

Næste skridt

Hastighedsgrænser

Godkendelse

​Fejlformat

​Fejlkoder

​Valideringsfejl

​Håndter fejl

​Almindelige problemer

​Næste skridt

Hastighedsgrænser

Godkendelse

Fejlformat

Fejlkoder

Valideringsfejl

Håndter fejl

Almindelige problemer

Næste skridt