Response contract
Error object पढ़ें
Request fail होने पर JSON response में status, false होता है। Application logic के लिए numeric errno और logs या पढ़ने योग्य diagnostics के लिए errmsg इस्तेमाल करें।
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errmsg wording के बजाय errno पर branch करें। भविष्य में explanatory text बदलने पर भी integration predictable रहेगा।Complete reference
GenderAPI error codes
ये values मौजूदा public GenderAPI documentation से मेल खाती हैं। Request दोहराने से पहले कारण ठीक करें।
access deniedRequest unauthorized IP address या referrer से आया।
invalid country codeCountry value supported ISO 3166-1 alpha-2 code नहीं है।
name not set || email not set || username not setRequest में जरूरी name, email या username parameter मौजूद नहीं है।
too many names || too many emails || too many usernamesRequest batch limit से बड़ा है: 100 names, 50 emails या 50 usernames।
query limit reachedAPI key में कोई credit बाकी नहीं है।
invalid or missing keyAPI key मौजूद नहीं है या मिल नहीं रही।
API key has expiredAPI key से जुड़ा package expire हो गया है।
Handling guidance
सुरक्षित रूप से fail करें और blind retries से बचें
पहले validate करें
Missing inputs, invalid country codes और oversized batches को API तक पहुँचने से पहले reject करें।
Credentials सुरक्षित रखें
API keys server पर रखें और application logs, browser output व support screenshots से redact करें।
चुनिंदा retry करें
इन errors में correction या account action जरूरी है। वही request बिना बदलाव दोहराने से समस्या ठीक नहीं होगी।
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Diagnostic details private रखें
Error number को internal request identifier के साथ log करें, लेकिन API key कभी शामिल न करें। Raw credentials या internal request data दिखाने के बजाय users को संक्षिप्त और actionable message दें।
दस्तावेज़ पूर्ण