Ruka hadi kwenye maudhui makuu

Hitilafu na majaribio ya kurudia

API za Alkax hutumia misimbo ya hali ya HTTP kwa matokeo ya msingi na miili ya majibu yenye muundo kwa maelezo yanayosomeka na mashine na watu.

Misimbo ya kawaida ya hali​

HaliMaanaHatua ya mteja
400Ombi batili au kushindwa kwa uhakikiSahihisha ombi kabla ya kulituma tena
401Kitambulisho kinakosekana, hakijaundwa vizuri, ni batili, kimeisha muda au kimebatilishwaBadilisha kitambulisho
402Usajili wa kulipia unahitajikaWasha au fanya upya usajili wa mwenye mradi
403Utambulisho umethibitishwa lakini hakuna ruhusaKagua ruhusa, ufikiaji na umiliki wa tenant
404Rasilimali haipatikani au haionekani kwa tenant huyuHakiki kitambulisho thabiti; usichunguze kwa kurudia
409Mgongano wa mzunguko wa maisha, nakala rudufu au idempotencySoma rasilimali ya sasa na upatanishe
429Kikomo cha kasi au mgao wa mpango wa mwezi umefikiwaHeshimu Retry-After, punguza matumizi au boresha mpango
5xxKushindwa kwa muda kwa sevaJaribu tena mara chache zilizowekewa kikomo, ukiongeza muda wa kusubiri kwa hatua za kizidishi

Njia salama ya kujaribu tena​

  1. Weka muda wa mwisho wa kusubiri ombi.
  2. Jaribu tena tu kwa kushindwa kwa mtandao, 429 na matokeo ya muda ya 5xx yaliyoandikwa.
  3. Tumia tena ufunguo uleule wa idempotency unapojaribu tena ombi lilelile la kuunda.
  4. Ongeza muda wa kusubiri kwa hatua za kizidishi pamoja na utofauti wa nasibu.
  5. Acha baada ya idadi maalumu ya majaribio na uoneshe tatizo ili likaguliwe.

Usirudie kamwe jibu la 400 bila kubadilisha ombi. Epuka kuunda ufunguo mpya wa idempotency kwa sababu tu jibu la kwanza lilipotea; hilo linaweza kugeuza kitendo kimoja kilichokusudiwa kuwa viwili.

Ujumbe wa lugha za eneo​

Baadhi ya API hutafsiri ujumbe unaosomeka na watu kulingana na Accept-Language. Usifanye mantiki ya programu itegemee maandishi yaliyotafsiriwa. Badala yake hifadhi hali, kitambulisho thabiti cha rasilimali na msimbo wa hitilafu unaosomeka na mashine.