Documentation / API Errors

API error handling

iGaming integrations కోసం responses, error codes, temporary failures, unknown outcomes, diagnostics మరియు safe recovery‌కు ఒక unified model.

Testing చూడండి
HTTP
request outcome
Codes
స్పష్టమైన కారణం
Retry
safe action
Trace
request diagnostics
Error-handling cycle

API response నుండి recovery వరకు

01
Outcome type నిర్ణయించండి

HTTP status, reason code, error category మరియు operation state తనిఖీ చేయండి.

02
Investigation కోసం data save చేయండి

Request మరియు operation identifiers, endpoint, time, provider reference మరియు safe parameters నమోదు చేయండి.

03
Safe action ఎంచుకోండి

Data సరిచేయండి, operation ఆపండి, delay తర్వాత retry చేయండి లేదా current state check చేయండి.

04
Recover చేసి verify చేయండి

Duplicates నివారించండి, results reconcile చేయండి, responsible teams‌కు notify చేసి root cause close చేయండి.

Overview

Error కారణం మరియు next action రెండింటినీ వివరించాలి

HTTP 400 లేదా 500 response ఒక్కటే సరిపోదు. Reliable API stable reason code‌ను return చేసి, response‌ను request identifier‌తో link చేసి, data సరిచేయాలా, operation ఆపాలా, request retry చేయాలా లేదా state‌ను separately check చేయాలా స్పష్టంగా చూపాలి.

Stable reason code

Stable error code client logic, reporting మరియు automatic enquiry routing‌లో ఉపయోగించబడుతుంది.

Predictable action

Error category request retry చేయవచ్చా, ఏ data మార్చాలో సూచిస్తుంది.

Diagnostic correlation

Request, operation మరియు provider identifiers client logs‌ను internal systems మరియు support‌తో link చేస్తాయి.

Error structure

Recommended error response structure

Internal implementation లేదా sensitive data‌ను expose చేయకుండా response compact, stable మరియు automated processing‌కు suitable‌గా ఉండాలి.

Error code

Explanatory message edit చేసినా మారని reason‌కు stable identifier.

Description

Internal code, database queries, secrets లేదా unnecessary detail లేకుండా చిన్న మరియు safe explanation.

Request ID

Logs‌లో operation‌ను కనుగొనడానికి మరియు support‌ను contact చేయడానికి unique identifier.

Additional data

Allowed status, limit, current state లేదా safe rejection reason.

Retryable

Operation duplicate protection‌ను తొలగించకుండా temporary error‌ను స్పష్టంగా సూచించే marker.

Retry ముందు delay

Rate limiting మరియు temporary unavailability కోసం seconds‌లో recommended delay లేదా HTTP header.

Field errors

Reason code, value path మరియు safe explanation‌తో problematic fields list.

Documentation reference

Cause మరియు fix విధానం వివరించే permanent link లేదా section identifier.

Error categories

ప్రధాన error categories

HTTP status general outcome class‌ను చూపుతుంది; internal code specific cause మరియు permitted action‌ను గుర్తిస్తుంది.

Input validation error

Invalid format, required field లేకపోవడం, unsupported value, తప్పు amount precision లేదా invalid request structure.

Authentication error

Missing, expired లేదా invalid token, API key, signature, request timestamp లేదా nonce.

Insufficient permissions

Client గుర్తించబడినా అవసరమైన role, brand, market లేదా action permission లేదు.

Object not found

Player, payment, round, KYC check, provider లేదా మరో object లేదు లేదా client‌కు available కాదు.

State conflict

Object version లేదా state మారింది, లేదా operation identifier ఇప్పటికే వేరే parameters‌తో ఉపయోగించబడింది.

Business rule violation

Insufficient balance, exceeded limit, blocked player, prohibited market లేదా invalid status transition.

Too many requests

Client, method, role లేదా critical operation‌కు permitted request count మించిపోయింది.

Provider unavailable

External service unavailable‌గా ఉంది, slow response ఇస్తోంది లేదా తాత్కాలికంగా operations accept చేయడం లేదు.

Internal error

Internal details expose చేయకుండా, diagnostics కోసం identifier‌తో unexpected platform error.

Retries మరియు recovery

Request retry మరియు unknown outcome

Error type గుర్తించి, original operation ఇప్పటికే complete అయి ఉండవచ్చా అని check చేసిన తర్వాత మాత్రమే retry safe.

01

Retry అనుమతించబడిందో తనిఖీ చేయండి

Data, permission మరియు business-rule errors సాధారణంగా request‌ను resend చేయడం కంటే సరిచేయాల్సి ఉంటుంది.

02

అదే operation key ఉంచండి

Financial, gaming లేదా ఇతర critical operation‌ను retry చేసినప్పుడు కొత్త result సృష్టించకూడదు.

03

Attempts మధ్య delay పెంచండి

Intervals క్రమంగా పెరుగుతాయి, server ఇచ్చిన delay‌ను గౌరవిస్తాయి మరియు total attempts‌ను limit చేస్తాయి.

04

ఆపి review‌కు escalate చేయండి

అన్ని attempts ముగిసిన తర్వాత operation incomplete‌గా record చేసి manual review లేదా reconciliation‌కు పంపాలి.

Response రాకపోవడం అంటే operation fail అయిందని కాదు

Request పంపిన తర్వాత connection drop అయితే outcome unknown‌గా ఉండవచ్చు. Retry చేయడానికి ముందు operation identifier ద్వారా state check చేయండి లేదా trusted notification కోసం wait చేయండి.

Diagnostics మరియు control

Logs, identifiers, metrics మరియు alerts

Unnecessary sensitive data store చేయకుండా platform, adapter మరియు external provider మధ్య request path‌ను diagnostics reconstruct చేయాలి.

Investigation context

Request, correlation, operation మరియు external provider identifiers.
Endpoint, HTTP method, environment, client, time మరియు response duration.
HTTP status, error code, attempts count మరియు final state.
Masked sensitive fields, safe headers మరియు signature validation result.

Monitoring మరియు alerts

Method, provider, client మరియు reason category ప్రకారం error rate.
Slow responses, HTTP 5xx errors, invalid signatures మరియు rate-limit events పెరగడం.
Retries సంఖ్య, unknown outcomes ఉన్న operations మరియు recovery tasks.
Thresholds, owners మరియు escalation rules‌తో alerts.
Testing

Test environment‌లో ఏమి test చేయాలి

Test environment ప్రతి ముఖ్యమైన error category‌ను reproduce చేసి client, retry మరియు control behavior సరైనదని confirm చేయాలి.

Input validation errors

Missing fields, invalid types, unsupported values, amount precision మరియు ఒకేసారి multiple errors.

Access మరియు permissions

Invalid key, expired token, incorrect signature, unauthorised role, blocked IP మరియు reused nonce.

Response లేదు మరియు unknown outcome

Sending ముందు, operation accept అయిన తర్వాత మరియు final response receive చేస్తున్నప్పుడు connection failure.

Rate limiting

HTTP 429, recommended delay, concurrent requests మరియు limit ముగిసిన తర్వాత recovery.

Provider errors

Unavailability, maintenance, invalid response, delayed notification మరియు conflicting status.

Retry మరియు protective stop

Attempt count limit చేయడం, delays పెంచడం, requests‌ను తాత్కాలికంగా stop చేయడం, controlled recovery మరియు manual escalation.

Pre-launch checklist

Error structure, client behavior, duplicate protection మరియు diagnostics validate చేసిన తర్వాత production integration launch చేయాలి.

అన్ని errors stable reason code మరియు request identifier return చేస్తాయి.
Error details secrets లేదా internal implementation‌ను expose చేయవు.
Temporary మరియు permanent error categories documentation‌లో ఉన్నాయి.
Retried critical operation అదే idempotency key ఉపయోగిస్తుంది.
Unknown outcome state check లేదా trusted notification ద్వారా handle చేయబడుతుంది.
Logs, metrics, alerts, recovery queue మరియు escalation rules configure చేయబడ్డాయి.

API errors‌ను standardize చేయాలా?

మీ current HTTP responses, error codes, retry rules మరియు problematic scenarios పంపండి. APIACE unified error model, safe recovery మరియు control approach నిర్వచించడంలో సహాయపడుతుంది.