Ag tosú

Earráidí

Nuair a théann rud éigin mícheart, freagraíonn an API leis an stádas HTTP cuí agus le corp a bhfuil code agus message ann laistigh de error.

Úsáid an code i do ríomhchlár. Is téacs i mBéarla é an message, chun cabhrú le duine atá ag dífhabhtú, agus d’fhéadfadh sé athrú.

Formáid na hearráide404

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

Gan eochair401

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

Cóid earráide

Stádas	Cód	Cathain a tharlaíonn sé
400	`key_in_query`	Seoladh an eochair san URL (paraiméadair `api_key`, `apikey`, `key` nó `token`). Seol sa cheanntásc í agus gin eochair nua, mar d’fhéadfadh an ceann roimhe a bheith taifeadta i logaí.
400	`invalid_parameter`	Tá luach neamhbhailí ag paraiméadar, mar shampla `per_page` os cionn an uasmhéid.
401	`missing_api_key`	Ní raibh eochair san iarratas.
401	`invalid_api_key`	Níl an eochair ann, cúlghaireadh í, nó tá a húsáideoir díghníomhachtaithe.
404	`not_found`	Níl an críochphointe ann, nó níl an mhír ann nó baineann sí le heagraíocht nach féidir leis an úsáideoir a fheiceáil.
404	`organization_not_found`	Níl an `organization` a tugadh ar cheann de na heagraíochtaí inar féidir leis an úsáideoir an cineál seo míre a fheiceáil.
405	`method_not_allowed`	Ní ghlacann an API ach le `GET` (agus `HEAD`).
429	`rate_limited`	Sroicheadh an teorainn iarratas. Fan ar feadh líon na soicindí in `Retry-After`.
500	`server_error`	Earráid inmheánach. Bain triail eile as i gceann tamaillín; má leanann sé, déan teagmháil leis an bhfoireann tacaíochta.

Cathain is ceart triail eile a bhaint as

Ná déan an t-iarratas céanna arís ach amháin tar éis 429 (agus tú ag fanacht ar Retry-After) nó 500. Is gá an t-iarratas nó an eochair a cheartú i gcás earráidí eile.