Documentation / API Errors

API error handling

ለiGaming integrations የresponses፣ error codes፣ temporary failures፣ unknown results፣ diagnostics እና safe recovery አንድ የጋራ መዋቅር።

Testing ክፈት

HTTP

የrequest ውጤት

Codes

ግልጽ ምክንያት

Retry

ደህንነቱ የተጠበቀ እርምጃ

Request diagnostics

የerror handling ዑደት

ከAPI response እስከ recovery

ERROR CONTROL

የውጤቱን ዓይነት ይወስኑ

HTTP status፣ reason code፣ error category እና operation state ያረጋግጡ።

ለትንተና ውሂብ ያስቀምጡ

Request እና operation IDs፣ method endpoint፣ time፣ provider reference እና safe parameters ይመዝግቡ።

ደህንነቱ የተጠበቀ እርምጃ ይምረጡ

ውሂቡን ያስተካክሉ፣ operationውን ያቁሙ፣ requestውን ከእረፍት በኋላ ይድገሙ ወይም የአሁኑን state ያረጋግጡ።

ይመልሱ እና ይቆጣጠሩ

Duplicatesን ያስወግዱ፣ reconciliation ያድርጉ፣ ኃላፊዎችን ያሳውቁ እና የfailure ምክንያቱን ይዝጉ።

በዚህ ገጽ

Requestውን በራስ-ሰር አይድገሙ

Retry የሚፈቀደው temporary error ሲሆን፣ operationው ከduplicates የተጠበቀ ወይም stateውን በደህንነት ማረጋገጥ ሲቻል ብቻ ነው።

Overview

Errorው ምክንያቱን እና ቀጣዩን እርምጃ ማብራራት አለበት

HTTP 400 ወይም 500 response ብቻ በቂ አይደለም። አስተማማኝ API የተረጋጋ reason code ይመልሳል፣ responseውን ከrequest ID ጋር ያገናኛል እና dataን ማስተካከል፣ operationን ማቆም፣ requestን መድገም ወይም stateውን በተለየ ሁኔታ ማረጋገጥ እንዳለበት ለመረዳት ያስችላል።

የተረጋጋ reason code

ቋሚ error code በclient logic፣ reports እና automated ticket routing ውስጥ ይጠቀማል።

ሊተነበይ የሚችል እርምጃ

የerror category requestውን መድገም እንደሚቻል እና ምን ውሂብ መቀየር እንዳለበት ያሳያል።

ለdiagnostics ግንኙነት

Request፣ operation እና provider IDs የclient logsን ከinternal systems እና support ጋር ያገናኛሉ።

የerror መዋቅር

የሚመከረው error response መዋቅር

Responseው internal implementationን ወይም sensitive dataን ሳያጋልጥ አጭር፣ የተረጋጋ እና ለautomated processing ተስማሚ መሆን አለበት።

Error code

የማብራሪያ መልዕክቱ ሲስተካከል የማይቀየር የተረጋጋ reason identifier።

መግለጫ

Internal code፣ database queries፣ secrets ወይም አላስፈላጊ ዝርዝሮችን የማያሳይ አጭር እና ደህንነቱ የተጠበቀ ማብራሪያ።

Request ID

Operationውን በlogs ውስጥ ለመፈለግ እና supportን ለማነጋገር የሚያገለግል unique identifier።

ተጨማሪ ውሂብ

የተፈቀደ status፣ limit፣ current state ወይም ደህንነቱ የተጠበቀ rejection reason።

Retry ይቻላል

Temporary error መሆኑን የሚያሳይ ግልጽ ምልክት፣ ነገር ግን operationውን ከduplicate execution የሚጠብቀውን መከላከያ አያስቀርም።

ከretry በፊት እረፍት

ለrate limiting እና temporary unavailability በseconds የሚመከር delay ወይም HTTP header።

የfield errors

Reason code፣ value path እና safe explanation ያላቸው ችግኝ መስኮች ዝርዝር።

የdocumentation አገናኝ

ምክንያቱን እና የማስተካከያ መንገዱን የሚገልጽ permanent link ወይም section identifier።

የerror ምድቦች

ዋና የerror ምድቦች

HTTP status የውጤቱን አጠቃላይ class ያሳያል፣ internal code ደግሞ ትክክለኛውን ምክንያት እና የተፈቀደውን እርምጃ ይገልጻል።

የinput data error

የተሳሳተ format፣ የጎደለ required field፣ unsupported value፣ የamount precision ችግኝ ወይም የrequest structure ጉድለት።

Authentication error

የጎደለ፣ expired ወይም invalid token፣ API key፣ signature፣ request time ወይም one-time identifier።

በቂ ፈቃድ የለም

Clientው ታውቋል፣ ግን የሚያስፈልገው role፣ brand፣ market ወይም action permission የለውም።

Object አልተገኘም

Player፣ payment፣ round፣ KYC check፣ provider ወይም ሌላ object የለም ወይም ለclientው አይገኝም።

State conflict

የobject version ወይም state ተቀይሯል፣ ወይም operation IDው ከሌሎች parameters ጋር አስቀድሞ ተጠቅሟል።

የbusiness rule ጥሰት

በቂ ያልሆነ balance፣ ያለፈ limit፣ blocked player፣ prohibited market ወይም የማይፈቀድ status transition።

በጣም ብዙ requests

ለclient፣ method፣ role ወይም critical operation የተፈቀደው የrequests ብዛት ተሻግሯል።

Provider አይገኝም

External service አይገኝም፣ ዘግይቶ ይመልሳል ወይም ለጊዜው operationsን አይቀበልም።

Internal error

Internal detailsን ሳያጋልጥ ግን diagnostics identifier ያለው ያልተጠበቀ platform error።

Retry እና recovery

Request retry እና unknown result

Retry ደህንነቱ የተጠበቀው error type ከታወቀ እና ዋናው operation አስቀድሞ ሊፈጸም እንደቻለ ከተረጋገጠ በኋላ ብቻ ነው።

Retry የተፈቀደ መሆኑን ያረጋግጡ

Data፣ permission እና business-rule errors ብዙውን ጊዜ requestውን ማስተካከል ይጠይቃሉ፣ እንደገና መላክን አይደለም።

ተመሳሳይ operation key ያስቀምጡ

Financial፣ gaming ወይም ሌላ critical operation ሲደገም አዲስ ውጤት መፍጠር የለበትም።

በattempts መካከል ያለውን እረፍት ያሳድጉ

Intervals ቀስ በቀስ ይጨምራሉ፣ server የጠቀሰውን ጊዜ ይጠብቃሉ እና አጠቃላይ attempt countን ይገድባሉ።

ያቁሙ እና ለreview ያስተላልፉ

Attempts ሲያልቁ operationው እንዳልተጠናቀቀ ይመዘገባል እና ወደ manual review ወይም reconciliation ይላካል።

Response አለመኖር operationው ውድቅ ሆኗል ማለት አይደለም

Requestው ከተላከ በኋላ connection ከተቋረጠ ውጤቱ unknown ሊሆን ይችላል። Retry ከማድረግ በፊት stateውን በoperation ID ያረጋግጡ ወይም trusted notification ይጠብቁ።

Diagnostics እና control

Logs፣ identifiers፣ metrics እና notifications

Diagnostics ከplatform ወደ adapter እና external provider ያለውን request path አላስፈላጊ sensitive data ሳያከማች እንደገና ማየት ማስቻል አለበት።

ለትንተና አውድ

Request፣ correlation፣ operation እና external provider IDs።

Method endpoint፣ HTTP request method፣ environment፣ client፣ time እና response duration።

HTTP status፣ error code፣ attempt count እና final state።

Masked sensitive fields፣ safe headers እና signature verification result።

Monitoring እና notifications

የerrors መጠን በmethod፣ provider፣ client እና reason category።

Long responses፣ HTTP 5xx፣ invalid signatures እና rate-limit hits መጨመር።

የretries ብዛት፣ unknown-result operations እና recovery tasks።

Thresholds፣ responsible owners እና escalation rules ያላቸው notifications።

Testing

በtest environment ውስጥ ምን መፈተሽ አለበት

Test environmentው እያንዳንዱን አስፈላጊ error category መድገም እና client፣ retries እና control ትክክለኛ ባህሪን ማረጋገጥ አለበት።

የinput data errors

የጎደሉ fields፣ wrong types፣ unsupported values፣ amount precision እና ብዙ errors በአንድ ጊዜ።

Access እና permissions

Invalid key፣ expired token፣ wrong signature፣ unauthorized role፣ blocked IP እና repeated one-time identifier።

Response የለም እና ውጤቱ unknown ነው

Request ከመላኩ በፊት፣ operation ከተቀበለ በኋላ እና final response እየተቀበለ ሳለ connection መቋረጥ።

Rate limiting

HTTP 429፣ የሚመከር pause፣ parallel requests እና limitው ካለቀ በኋላ recovery።

Provider errors

Unavailability፣ maintenance፣ invalid response፣ delayed notification እና conflicting status።

Retry እና protective stop

Attempt count መገደብ፣ pause ማሳደግ፣ requestsን ለጊዜው ማቆም፣ controlled recovery እና manual escalation።

ከlaunch በፊት checklist

Production integration error structure፣ client behavior፣ duplicate protection እና diagnostics ከተፈተሹ በኋላ ይጀምራል።

ሁሉም errors የተረጋጋ reason code እና request ID ይመልሳሉ።

Error details secretsን ወይም internal implementationን አያጋልጡም።

Temporary እና permanent error categories በdocumentation ውስጥ ተገልጸዋል።

Critical operation retry ተመሳሳይ duplicate-protection key ይጠቀማል።

Unknown result state check ወይም trusted notification በመጠቀም ይስተናገዳል።

Logs፣ metrics፣ notifications፣ recovery queue እና escalation rules ተዘጋጅተዋል።