Začíname

Chyby

Keď sa niečo pokazí, API odpovie zodpovedajúcim stavovým kódom HTTP a telom, ktoré v error obsahuje code a message.

Vo svojom programe používajte code. Pole message obsahuje anglický text, ktorý má pomôcť pri ladení, a môže sa zmeniť.

Formát chyby404

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

Bez kľúča401

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

Chybové kódy

Stav	Kód	Kedy nastáva
400	`key_in_query`	Kľúč bol poslaný v adrese (parametre `api_key`, `apikey`, `key` alebo `token`). Posielajte ho v hlavičke a vygenerujte nový kľúč, pretože ten predchádzajúci sa mohol uložiť do logov.
400	`invalid_parameter`	Parameter má neplatnú hodnotu, napríklad `per_page` nad povoleným maximom.
401	`missing_api_key`	Požiadavka neobsahovala kľúč.
401	`invalid_api_key`	Kľúč neexistuje, bol odvolaný alebo je jeho používateľ deaktivovaný.
404	`not_found`	Endpoint neexistuje, prípadne položka neexistuje alebo patrí organizácii, ktorú používateľ nemôže vidieť.
404	`organization_not_found`	Zadaný parameter `organization` nezodpovedá organizácii, v ktorej môže používateľ vidieť tento typ položiek.
405	`method_not_allowed`	API prijíma iba `GET` (a `HEAD`).
429	`rate_limited`	Bol dosiahnutý limit požiadaviek. Počkajte počet sekúnd uvedený v `Retry-After`.
500	`server_error`	Interná chyba. Skúste to o chvíľu znova; ak problém pretrváva, kontaktujte podporu.

Kedy to skúsiť znova

Rovnakú požiadavku má zmysel opakovať iba po chybe 429 (po uplynutí času z Retry-After) alebo 500. Ostatné chyby si vyžadujú opravu požiadavky alebo kľúča.