Smlouva odpovědi
Čtení chybového objektu
Při neúspěšném požadavku vrátí odpověď JSON hodnotu status nastavenou na false. Pro logiku aplikace používejte číselné errno; errmsg ponechte pro protokoly nebo srozumitelnou diagnostiku.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errno, nikoli podle přesného znění errmsg. Integrace tak zůstane předvídatelná, i když se vysvětlující text později změní.Úplný přehled
Chybové kódy GenderAPI
Následující hodnoty odpovídají aktuální veřejné dokumentaci GenderAPI. Před opakováním požadavku odstraňte příčinu.
access deniedPožadavek přišel z nepovolené IP adresy nebo refereru.
invalid country codeHodnota země není podporovaný kód ISO 3166-1 alpha-2.
name not set || email not set || username not setV požadavku chybí povinný parametr name, email nebo username.
too many names || too many emails || too many usernamesPožadavek překračuje dávkový limit: 100 jmen, 50 e-mailů nebo 50 uživatelských jmen.
query limit reachedAPI klíč nemá žádné zbývající kredity.
invalid or missing keyAPI klíč chybí nebo jej nelze najít.
API key has expiredPlatnost balíčku spojeného s API klíčem vypršela.
Doporučení ke zpracování
Selhávejte bezpečně a neopakujte požadavky naslepo
Nejprve ověřujte
Chybějící vstupy, neplatné kódy zemí a příliš velké dávky odmítněte ještě před odesláním do API.
Chraňte přihlašovací údaje
API klíče uchovávejte na serveru a odstraňujte je z aplikačních protokolů, výstupu prohlížeče i snímků obrazovky pro podporu.
Opakujte selektivně
Tyto chyby vyžadují opravu požadavku nebo zásah v účtu. Nezměněný požadavek problém nevyřeší.
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Diagnostické údaje ponechte soukromé
Chybové číslo zaznamenejte s interním identifikátorem požadavku, nikdy však s API klíčem. Uživatelům zobrazte stručnou a použitelnou zprávu místo nezpracovaných přihlašovacích údajů nebo interních dat.
Dokumentace dokončena