Svarskontrakt
Läs felobjektet
När en förfrågan misslyckas returnerar JSON-svaret status som false. Använd det numeriska errno i applikationslogiken och behåll errmsg för loggar eller läsbar diagnostik.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errno, inte den exakta formuleringen i errmsg. Integrationen förblir då förutsägbar om förklaringstexten ändras senare.Fullständig referens
GenderAPI-felkoder
Följande värden motsvarar den aktuella offentliga GenderAPI-dokumentationen. Åtgärda orsaken innan förfrågan upprepas.
access deniedFörfrågan kom från en IP-adress eller referrer som saknar behörighet.
invalid country codeVärdet för land är inte en giltig ISO 3166-1 alpha-2-kod som stöds.
name not set || email not set || username not setFörfrågan saknar den obligatoriska parametern name, email eller username.
too many names || too many emails || too many usernamesFörfrågan överskrider batchgränsen: 100 namn, 50 e-postadresser eller 50 användarnamn.
query limit reachedAPI-nyckeln har inga krediter kvar.
invalid or missing keyAPI-nyckeln saknas eller kan inte hittas.
API key has expiredPaketet som är kopplat till API-nyckeln har upphört att gälla.
Hanteringsprinciper
Misslyckas säkert och undvik blinda återförsök
Validera först
Avvisa saknad indata, ogiltiga landskoder och för stora batcher innan de når API:et.
Skydda autentiseringsuppgifter
Förvara API-nycklar på servern och maskera dem i applikationsloggar, webbläsarutdata och skärmbilder för support.
Försök igen selektivt
Dessa fel kräver korrigering eller en kontoåtgärd. Samma oförändrade förfrågan löser inte problemet.
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Håll diagnostiska uppgifter privata
Logga felnumret tillsammans med ett internt request-ID, men aldrig API-nyckeln. Visa användaren ett kort och handlingsinriktat meddelande i stället för råa autentiseringsuppgifter eller intern förfrågningsdata.
Dokumentationen är klar