Pradžia
Klaidos
Kai kas nors nepavyksta, API atsako atitinkamu HTTP būsenos kodu ir turiniu, kurio lauke error yra code ir message.
Savo programoje naudokite code. message yra tekstas anglų kalba, skirtas padėti derinant, ir jis gali keistis.
Klaidos formatas404
{
"error": {
"code": "not_found",
"message": "Item not found or you do not have access to it."
}
}Nėra rakto401
{
"error": {
"code": "missing_api_key",
"message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
}
}Klaidų kodai
| Būsena | Kodas | Kada įvyksta |
|---|---|---|
| 400 | key_in_query |
Raktas buvo išsiųstas URL adrese (parametrai api_key, apikey, key arba token). Siųskite jį antraštėje ir sukurkite naują raktą, nes ankstesnis galėjo būti įrašytas į žurnalus. |
| 400 | invalid_parameter |
Parametras turi netinkamą reikšmę, pavyzdžiui, per_page viršija didžiausią leistiną. |
| 401 | missing_api_key |
Užklausoje nebuvo rakto. |
| 401 | invalid_api_key |
Raktas neegzistuoja, buvo panaikintas arba jo naudotojas deaktyvuotas. |
| 404 | not_found |
Galinis taškas neegzistuoja arba elementas neegzistuoja ar priklauso organizacijai, kurios naudotojas negali matyti. |
| 404 | organization_not_found |
Nurodytas organization nėra organizacija, kurioje naudotojas gali matyti šio tipo elementus. |
| 405 | method_not_allowed |
API priima tik GET (ir HEAD). |
| 429 | rate_limited |
Pasiektas užklausų apribojimas. Palaukite Retry-After nurodytą sekundžių skaičių. |
| 500 | server_error |
Vidinė klaida. Netrukus bandykite dar kartą; jei klaida kartojasi, susisiekite su pagalbos tarnyba. |
Kada bandyti dar kartą
Tą pačią užklausą verta kartoti tik po 429 (palaukus Retry-After) arba 500. Kitoms klaidoms reikia pataisyti užklausą arba raktą.