Premye pa

Erè

Lè yon bagay mal pase, API a reponn ak estati HTTP ki koresponn lan ak yon kò ki gen code ak message anndan error.

Sèvi ak code nan pwogram ou. message se yon tèks an anglè pou ede moun k ap chèche pwoblèm nan kòd la, epi li ka chanje.

Fòma erè a404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}
San kle401
{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Kòd erè

Estati Kòd Ki lè sa rive
400 key_in_query Yo te voye kle a nan adrès la (paramèt api_key, apikey, key oswa token). Voye l nan antèt la epi jenere yon nouvo kle, paske ansyen an ka te anrejistre nan log yo.
400 invalid_parameter Yon paramèt gen yon valè ki pa valab, tankou per_page ki depase maksimòm nan.
401 missing_api_key Demann lan pa t gen kle.
401 invalid_api_key Kle a pa egziste, yo revoke l, oswa itilizatè li a dezaktive.
404 not_found Endpoint la pa egziste, oswa eleman an pa egziste oswa li fè pati yon òganizasyon itilizatè a pa ka wè.
404 organization_not_found organization yo bay la pa koresponn ak yon òganizasyon kote itilizatè a ka wè kalite eleman sa a.
405 method_not_allowed API a aksepte sèlman GET (ak HEAD).
429 rate_limited Limit demann lan rive. Tann kantite segonn ki endike nan Retry-After.
500 server_error Erè entèn. Eseye ankò nan kèk moman; si pwoblèm nan kontinye, kontakte sipò a.

Ki lè pou eseye ankò

Repete menm demann lan sèlman apre yon 429 (apre w fin tann Retry-After) oswa yon 500. Pou lòt erè yo, fòk ou korije demann lan oswa kle a.