Unuaj paŝoj

Eraroj

Kiam io misfunkcias, la API respondas per la koncerna HTTP-statokodo kaj korpo kun code kaj message ene de error.

Uzu la code en via programo. La message estas angla teksto por helpi tiun, kiu sencimigas, kaj ĝi povas ŝanĝiĝi.

Formato de la eraro404

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

Sen ŝlosilo401

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

Erarkodoj

Stato	Kodo	Kiam ĝi okazas
400	`key_in_query`	La ŝlosilo estis sendita en la adreso (parametroj `api_key`, `apikey`, `key` aŭ `token`). Sendu ĝin en la kaplinio kaj generu novan ŝlosilon, ĉar la antaŭa eble restis registrita en protokoloj.
400	`invalid_parameter`	Parametro havas nevalidan valoron, ekzemple `per_page` super la maksimumo.
401	`missing_api_key`	La peto ne enhavis ŝlosilon.
401	`invalid_api_key`	La ŝlosilo ne ekzistas, estis revokita aŭ ĝia uzanto estas malaktivigita.
404	`not_found`	La finpunkto ne ekzistas, aŭ la ero ne ekzistas aŭ apartenas al organizaĵo, kiun la uzanto ne povas vidi.
404	`organization_not_found`	La indikita `organization` ne estas organizaĵo, en kiu la uzanto povas vidi ĉi tiun tipon de eroj.
405	`method_not_allowed`	La API akceptas nur `GET` (kaj `HEAD`).
429	`rate_limited`	La limo de petoj estis atingita. Atendu la sekundojn indikitajn en `Retry-After`.
500	`server_error`	Interna eraro. Reprovu post momento; se la problemo daŭras, kontaktu la subtenon.

Ripetu la saman peton nur post 429 (atendinte la Retry-After) aŭ post 500. La aliaj eraroj postulas korekton en la peto aŭ en la ŝlosilo.