Začínáme

Chyby

Když se něco pokazí, API odpoví odpovídajícím stavovým kódem HTTP a tělem, které v error obsahuje code a message.

Ve svém programu používejte code. Pole message obsahuje anglický text, který má pomoci při ladění, a může se změnit.

Formát chyby404

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

Bez klíče401

{
  "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	Kdy nastává
400	`key_in_query`	Klíč byl poslán v adrese (parametry `api_key`, `apikey`, `key` nebo `token`). Posílejte ho v hlavičce a vygenerujte nový klíč, protože ten předchozí se mohl uložit do logů.
400	`invalid_parameter`	Parametr má neplatnou hodnotu, například `per_page` nad povoleným maximem.
401	`missing_api_key`	Požadavek neobsahoval klíč.
401	`invalid_api_key`	Klíč neexistuje, byl odvolán nebo je jeho uživatel deaktivován.
404	`not_found`	Endpoint neexistuje, případně položka neexistuje nebo patří organizaci, kterou uživatel nemůže vidět.
404	`organization_not_found`	Zadaný parametr `organization` neodpovídá organizaci, ve které uživatel může vidět tento typ položek.
405	`method_not_allowed`	API přijímá pouze `GET` (a `HEAD`).
429	`rate_limited`	Byl dosažen limit požadavků. Počkejte počet sekund uvedený v `Retry-After`.
500	`server_error`	Interní chyba. Zkuste to za chvíli znovu; pokud potíže přetrvávají, kontaktujte podporu.

Kdy to zkusit znovu

Stejný požadavek má smysl opakovat jen po chybě 429 (po uplynutí doby z Retry-After) nebo 500. Ostatní chyby vyžadují opravu požadavku nebo klíče.