Feil

GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.

GetQR API-et bruker standard HTTP-statuskoder. Vellykkede forespørsler returnerer 2xx. Mislykkede forespørsler returnerer 4xx eller 5xx med en JSON-body som forklarer hva som gikk galt.

Feilformat

Alle feil har samme form: en stabil kode, en lesbar melding og en lenke til beskrivelsen av koden.

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

string

påkrevd

Stabil, maskinlesbar feilkode. Bruk den i koden din i stedet for meldingen. Se Feilkoder.

string

påkrevd

Lesbar beskrivelse av problemet. Ordlyden kan endres.

string

påkrevd

Lenke til beskrivelsen av feilkoden i API-dokumentasjonen i GetQR-kontoen din.

Feilkoder

Kode	HTTP-status	Når den oppstår
`bad_request`	400	Forespørselen er feil utformet: body er ikke gyldig JSON, `Authorization`-headeren mangler prefikset `Bearer` , eller handlingen er ikke tillatt i ressursens nåværende tilstand (for eksempel å avbryte en masseopprettelse som er ferdig).
`unauthorized`	401	API-nøkkelen mangler eller er ugyldig, for eksempel fordi den er generert på nytt.
`forbidden`	403	Abonnementet til eieren av arbeidsområdet er ikke aktivt, eller rollen din i arbeidsområdet tillater ikke denne handlingen.
`exceeded_limit`	403	Du har nådd en grense i abonnementet. På Single QR-abonnementet: å opprette eller duplisere en QR-kode når arbeidsområdet allerede har én, eller å starte en masseopprettelse.
`not_found`	404	Ressursen finnes ikke eller er ikke i arbeidsområdet ditt, endepunktet finnes ikke, eller API-et er ikke aktivert for arbeidsområdet ditt.
`method_not_allowed`	405	Endepunktet finnes, men godtar ikke denne HTTP-metoden. `Allow`-headeren viser metodene det godtar.
`conflict`	409	Forespørselen kolliderer med eksisterende data: slugen til kortlenken er tatt, en forespørsel med samme `Idempotency-Key` pågår fortsatt, en tidsplan overlapper en eksisterende, eller et arkiv fra en masseopprettelse er ikke klart ennå.
`invite_pending`	409	Du er invitert til arbeidsområdet, men har ikke blitt med ennå. Forespørsler med API-nøkkel returnerer den ikke: nøkkelens arbeidsområde er alltid ett du er medlem av.
`invite_expired`	410	Invitasjonen din til arbeidsområdet har utløpt. Forespørsler med API-nøkkel returnerer den ikke, av samme grunn.
`unprocessable_entity`	422	Body eller spørringsparametere besto ikke valideringen. Meldingen navngir feltet og hva som er galt med det. Se Valideringsfeil.
`rate_limit_exceeded`	429	API-nøkkelen har brukt opp forespørslene sine for gjeldende vindu. Se Hastighetsgrenser.
`internal_server_error`	500	Noe gikk galt hos oss. Prøv igjen senere, og kontakt kundestøtte hvis det fortsetter.

Valideringsfeil

Når body eller spørringsparametere ikke består valideringen, svarer API-et 422. Meldingen beskriver det første ugyldige feltet 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"
  }
}

Nestede felt bruker punktnotasjon, for eksempel link.url.

Håndter feil

Forgren på error.code, ikke på error.message.
Ikke prøv 4xx-feil på nytt uendret: rett forespørselen først. Unntakene er en 409 for en forespørsel som fortsatt pågår, og 429.
Ved 429 venter du det antallet sekunder som står i Retry-After-headeren. Se Hastighetsgrenser.
Prøv 5xx-feil på nytt med eksponentiell backoff.

Vanlige problemer

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

API-et er i beta og er ennå ikke aktivert for arbeidsområdet ditt.

404 "This endpoint does not exist."

Banen er feil. Sammenlign den med sidene for endepunktene, og sjekk at den starter med /api/v1/.

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

Abonnementet til eieren av arbeidsområdet er avsluttet. API-nøkkelen fungerer igjen så snart eieren tegner abonnement på nytt.

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

Rollen din i arbeidsområdet er leser. Bare eieren av arbeidsområdet og redaktører kan bruke API-et.

API

Feilformat

Feilkoder

Valideringsfeil

Håndter feil

Vanlige problemer

Neste steg

Hastighetsgrenser

Autentisering

​Feilformat

​Feilkoder

​Valideringsfeil

​Håndter feil

​Vanlige problemer

​Neste steg

Hastighetsgrenser

Autentisering

Feilformat

Feilkoder

Valideringsfeil

Håndter feil

Vanlige problemer

Neste steg