Prvi koraki
Napake
Ko gre kaj narobe, API odgovori z ustrezno statusno kodo HTTP in telesom, ki v error vsebuje code in message.
V svojem programu uporabljajte code. Polje message je besedilo v angleščini, ki pomaga pri odpravljanju napak, in se lahko spremeni.
Oblika napake404
{
"error": {
"code": "not_found",
"message": "Item not found or you do not have access to it."
}
}Brez ključa401
{
"error": {
"code": "missing_api_key",
"message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
}
}Kode napak
| Stanje | Koda | Kdaj se pojavi |
|---|---|---|
| 400 | key_in_query |
Ključ je bil poslan v naslovu (parametri api_key, apikey, key ali token). Pošljite ga v glavi in ustvarite nov ključ, ker je bil prejšnji morda zapisan v dnevnikih. |
| 400 | invalid_parameter |
Parameter ima neveljavno vrednost, na primer per_page nad največjo dovoljeno vrednostjo. |
| 401 | missing_api_key |
Zahteva ni vsebovala ključa. |
| 401 | invalid_api_key |
Ključ ne obstaja, je bil razveljavljen ali pa je njegov uporabnik deaktiviran. |
| 404 | not_found |
Končna točka ne obstaja ali pa element ne obstaja oziroma pripada organizaciji, ki je uporabnik ne more videti. |
| 404 | organization_not_found |
Podana vrednost organization ni organizacija, v kateri lahko uporabnik vidi to vrsto elementov. |
| 405 | method_not_allowed |
API sprejema samo GET (in HEAD). |
| 429 | rate_limited |
Omejitev zahtev je dosežena. Počakajte toliko sekund, kot je navedeno v Retry-After. |
| 500 | server_error |
Notranja napaka. Poskusite znova čez nekaj trenutkov; če se napaka ponavlja, se obrnite na podporo. |
Kdaj poskusiti znova
Isto zahtevo je smiselno ponoviti samo po napaki 429 (ko počakate čas iz Retry-After) ali 500. Druge napake zahtevajo popravek zahteve ali ključa.