Fel

GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.

GetQR:s API använder vanliga HTTP-statuskoder. Lyckade begäranden returnerar 2xx. Misslyckade begäranden returnerar 4xx eller 5xx med en JSON-body som förklarar vad som gick fel.

Felformat

Alla fel har samma form: en stabil kod, ett läsbart meddelande och en länk till kodens beskrivning.

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

string

obligatorisk

Stabil, maskinläsbar felkod. Använd den i din kod i stället för meddelandet. Se Felkoder.

string

obligatorisk

Läsbar beskrivning av problemet. Formuleringen kan ändras.

string

obligatorisk

Länk till felkodens beskrivning i API-dokumentationen i ditt GetQR-konto.

Felkoder

Kod	HTTP-status	När det inträffar
`bad_request`	400	Begäran är felaktigt utformad: body är inte giltig JSON, `Authorization`-huvudet saknar prefixet `Bearer` , eller åtgärden är inte tillåten i resursens nuvarande tillstånd (till exempel att avbryta ett slutfört massskapande).
`unauthorized`	401	API-nyckeln saknas eller är ogiltig, till exempel för att den har genererats om.
`forbidden`	403	Arbetsytans ägare har ingen aktiv prenumeration, eller så tillåter inte din roll i arbetsytan den här åtgärden.
`exceeded_limit`	403	Du har nått en gräns i abonnemanget. På abonnemanget Single QR: att skapa eller duplicera en QR-kod när arbetsytan redan har en, eller att starta ett massskapande.
`not_found`	404	Resursen finns inte eller ligger inte i din arbetsyta, slutpunkten finns inte, eller API:et är inte aktiverat för din arbetsyta.
`method_not_allowed`	405	Slutpunkten finns men accepterar inte den här HTTP-metoden. `Allow`-huvudet listar de metoder som accepteras.
`conflict`	409	Begäran krockar med befintliga data: den korta länkens slug är upptagen, en begäran med samma `Idempotency-Key` pågår fortfarande, ett schema överlappar ett befintligt, eller ett arkiv från massskapande är inte klart än.
`invite_pending`	409	Du har bjudits in till arbetsytan men har inte gått med än. Begäranden med API-nyckel returnerar inte koden: nyckelns arbetsyta är alltid en som du tillhör.
`invite_expired`	410	Din inbjudan till arbetsytan har gått ut. Begäranden med API-nyckel returnerar inte koden, av samma anledning.
`unprocessable_entity`	422	Body eller frågeparametrar klarade inte valideringen. Meddelandet anger fältet och vad som är fel. Se Valideringsfel.
`rate_limit_exceeded`	429	API-nyckeln har använt upp sina begäranden för det aktuella fönstret. Se Hastighetsbegränsningar.
`internal_server_error`	500	Något gick fel hos oss. Försök igen senare och kontakta supporten om det fortsätter.

Valideringsfel

När body eller frågeparametrar inte klarar valideringen svarar API:et 422. Meddelandet beskriver det första ogiltiga fältet 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"
  }
}

Nästlade fält skrivs med punktnotation, till exempel link.url.

Hantera fel

Förgrena på error.code, inte på error.message.
Försök inte igen med 4xx-fel utan ändringar: rätta begäran först. Undantagen är 409 för en begäran som fortfarande pågår och 429.
Vid 429 väntar du det antal sekunder som anges i Retry-After-huvudet. Se Hastighetsbegränsningar.
Försök igen med 5xx-fel med exponentiell backoff.

Vanliga problem

Varje begäran returnerar 404 "This endpoint is not available."

API:et är i beta och är inte aktiverat för din arbetsyta än.

404 "This endpoint does not exist."

Sökvägen är fel. Jämför den med sidorna för slutpunkterna och kontrollera att den börjar med /api/v1/.

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

Arbetsytans ägares prenumeration har upphört. API-nyckeln fungerar igen så fort ägaren förnyar prenumerationen.

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

Din roll i arbetsytan är läsare. Bara arbetsytans ägare och redigerare kan använda API:et.

API

Felformat

Felkoder

Valideringsfel

Hantera fel

Vanliga problem

Nästa steg

Hastighetsbegränsningar

Autentisering

​Felformat

​Felkoder

​Valideringsfel

​Hantera fel

​Vanliga problem

​Nästa steg

Hastighetsbegränsningar

Autentisering

Felformat

Felkoder

Valideringsfel

Hantera fel

Vanliga problem

Nästa steg