Dechrau arni

Gwallau

Pan aiff rhywbeth o'i le, mae'r API yn ymateb gyda'r statws HTTP perthnasol a chorff sy'n cynnwys code a message o fewn error.

Defnyddiwch y code yn eich rhaglen. Testun Saesneg yw'r message, i helpu pwy bynnag sy'n dadfygio, a gall newid.

Fformat y gwall404

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

Dim allwedd401

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

Codau gwall

Statws	Cod	Pryd mae'n digwydd
400	`key_in_query`	Anfonwyd yr allwedd yn yr URL (paramedrau `api_key`, `apikey`, `key` neu `token`). Anfonwch hi yn y pennyn a chynhyrchwch allwedd newydd, oherwydd efallai fod yr un flaenorol wedi'i chofnodi mewn logiau.
400	`invalid_parameter`	Mae gan baramedr werth annilys, fel `per_page` uwchlaw'r uchafswm.
401	`missing_api_key`	Doedd dim allwedd yn y cais.
401	`invalid_api_key`	Dydy'r allwedd ddim yn bodoli, mae wedi'i dirymu, neu mae ei defnyddiwr wedi'i ddadactifadu.
404	`not_found`	Dydy'r pwynt terfyn ddim yn bodoli, neu dydy'r eitem ddim yn bodoli neu mae'n perthyn i sefydliad na all y defnyddiwr ei weld.
404	`organization_not_found`	Nid yw'r `organization` a roddwyd yn sefydliad lle gall y defnyddiwr weld y math hwn o eitem.
405	`method_not_allowed`	Dim ond `GET` (a `HEAD`) y mae'r API yn eu derbyn.
429	`rate_limited`	Cyrhaeddwyd y terfyn ceisiadau. Arhoswch am nifer yr eiliadau yn `Retry-After`.
500	`server_error`	Gwall mewnol. Rhowch gynnig arall arni mewn ychydig; os yw'n parhau, cysylltwch â'r tîm cymorth.

Dim ond ar ôl 429 (gan aros am Retry-After) neu 500 y dylech ailadrodd yr un cais. Mae gwallau eraill yn gofyn am gywiro'r cais neu'r allwedd.