Első lépések

Hibák

Ha valami hiba történik, az API a megfelelő HTTP-állapotkóddal válaszol, a válasz törzsében pedig az error objektum tartalmazza a code és a message mezőt.

A programjában a code mezőt használja. A message angol nyelvű szöveg, amely a hibakeresést segíti, és változhat.

A hiba formátuma404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Kulcs nélkül401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Hibakódok

Állapot	Kód	Mikor fordul elő
400	`key_in_query`	A kulcsot a címben küldték el (`api_key`, `apikey`, `key` vagy `token` paraméterben). Küldje fejlécben, és generáljon új kulcsot, mert az előző bekerülhetett a naplókba.
400	`invalid_parameter`	Egy paraméter értéke érvénytelen, például a `per_page` meghaladja a maximumot.
401	`missing_api_key`	A kérés nem tartalmazott kulcsot.
401	`invalid_api_key`	A kulcs nem létezik, visszavonták, vagy a hozzá tartozó felhasználó inaktív.
404	`not_found`	A végpont nem létezik, vagy az elem nem létezik, illetve olyan szervezethez tartozik, amelyet a felhasználó nem láthat.
404	`organization_not_found`	A megadott `organization` nem olyan szervezet, amelyben a felhasználó láthatja az ilyen típusú elemeket.
405	`method_not_allowed`	Az API csak `GET` (és `HEAD`) kéréseket fogad.
429	`rate_limited`	Elérte a kéréskorlátot. Várjon annyi másodpercet, amennyit a `Retry-After` megad.
500	`server_error`	Belső hiba. Próbálja újra néhány pillanat múlva; ha a hiba továbbra is fennáll, forduljon az ügyfélszolgálathoz.

Mikor érdemes újrapróbálkozni

Ugyanazt a kérést csak 429 (a Retry-After kivárása után) vagy 500 hiba után érdemes megismételni. A többi hiba a kérés vagy a kulcs javítását igényli.