Hibák

A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.

A GetQR API szabványos HTTP-állapotkódokat használ. A sikeres kérések 2xx kódot adnak vissza. A sikertelen kérések 4xx vagy 5xx kódot adnak, egy JSON-törzzsel, amely leírja, mi ment félre.

A hibák formátuma

Minden hiba azonos felépítésű: egy állandó kód, egy ember által olvasható üzenet és egy hivatkozás a kód leírására.

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

string

kötelező

Állandó, géppel feldolgozható hibakód. A kódjában ezt használja, ne az üzenetet. Lásd: Hibakódok.

string

kötelező

A probléma ember által olvasható leírása. A megfogalmazás változhat.

string

kötelező

Hivatkozás a hibakód leírására a GetQR-fiókjában elérhető API-dokumentációban.

Hibakódok

Kód	HTTP-állapot	Mikor fordul elő
`bad_request`	400	A kérés hibás: a törzs nem érvényes JSON, az `Authorization` fejlécből hiányzik a `Bearer` előtag, vagy a művelet nem engedélyezett az erőforrás aktuális állapotában (például egy befejezett tömeges létrehozás megszakítása).
`unauthorized`	401	Az API-kulcs hiányzik vagy érvénytelen, például mert újragenerálták.
`forbidden`	403	A munkaterület tulajdonosának előfizetése nem aktív, vagy az Ön szerepköre a munkaterületen nem engedi ezt a műveletet.
`exceeded_limit`	403	Elérte a csomag egyik korlátját. A Single QR csomagban: QR-kód létrehozása vagy másolása, ha a munkaterületen már van egy, illetve tömeges létrehozás indítása.
`not_found`	404	Az erőforrás nem létezik vagy nem az Ön munkaterületéhez tartozik, a végpont nem létezik, vagy az API nincs engedélyezve a munkaterületén.
`method_not_allowed`	405	A végpont létezik, de nem fogadja ezt a HTTP-metódust. Az `Allow` fejléc felsorolja az elfogadott metódusokat.
`conflict`	409	A kérés ütközik a meglévő adatokkal: a rövid link azonosítója foglalt, egy azonos `Idempotency-Key` értékű kérés még folyamatban van, egy ütemezés átfed egy meglévővel, vagy egy tömeges archívum még nem készült el.
`invite_pending`	409	Meghívást kapott a munkaterületre, de még nem csatlakozott. API-kulcsos kérések nem adják vissza: a kulcs munkaterülete mindig olyan, amelynek Ön tagja.
`invite_expired`	410	A munkaterületre szóló meghívása lejárt. API-kulcsos kérések ugyanezen okból nem adják vissza.
`unprocessable_entity`	422	A törzs vagy a lekérdezési paraméterek nem mentek át a validáción. Az üzenet megnevezi a mezőt és a problémát. Lásd: Validációs hibák.
`rate_limit_exceeded`	429	Az API-kulcs elhasználta az aktuális időablakra jutó kéréseit. Lásd: Kéréskorlátok.
`internal_server_error`	500	Hiba történt a mi oldalunkon. Próbálja újra később, és ha a hiba ismétlődik, forduljon az ügyfélszolgálathoz.

Validációs hibák

Ha a törzs vagy a lekérdezési paraméterek nem mennek át a validáción, az API 422 kóddal válaszol. Az üzenet az első érvénytelen mezőt írja le, <issue>: <field>: <details> formában:

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

A beágyazott mezők pontjelölést használnak, például link.url.

Hibák kezelése

Az error.code alapján ágaztasson el, ne az error.message alapján.
A 4xx hibákat ne ismételje változtatás nélkül: előbb javítsa a kérést. Kivétel a még folyamatban lévő kérésre kapott 409 és a 429.
429 esetén várjon annyi másodpercet, amennyit a Retry-After fejléc megad. Lásd: Kéréskorlátok.
Az 5xx hibákat exponenciális visszalépéssel ismételje.

Gyakori problémák

Minden kérés 404-es hibát ad: „This endpoint is not available.”

Az API béta állapotban van, és a munkaterületén még nincs engedélyezve.

404 "This endpoint does not exist."

Az útvonal hibás. Vesse össze a végpontok oldalaival, és ellenőrizze, hogy /api/v1/ előtaggal kezdődik-e.

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

A munkaterület tulajdonosának előfizetése lejárt. Az API-kulcs azonnal újra működik, amint a tulajdonos megújítja az előfizetést.

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

Az Ön szerepköre a munkaterületen megtekintő. Az API-t csak a munkaterület tulajdonosa és a szerkesztők használhatják.

API

A hibák formátuma

Hibakódok

Validációs hibák

Hibák kezelése

Gyakori problémák

Következő lépések

Kéréskorlátok

Hitelesítés

​A hibák formátuma

​Hibakódok

​Validációs hibák

​Hibák kezelése

​Gyakori problémák

​Következő lépések

Kéréskorlátok

Hitelesítés

A hibák formátuma

Hibakódok

Validációs hibák

Hibák kezelése

Gyakori problémák

Következő lépések