Kontrakt for feilsvar
Les feilobjektet
Når en forespørsel mislykkes, returnerer JSON-svaret status som false. Bruk den numeriskeerrno-verdien i applikasjonslogikken, og behold errmsg for logger eller lesbar diagnostikk.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errno, ikke den nøyaktige teksten i errmsg. Slik forblir integrasjonen forutsigbar hvis forklaringsteksten endres senere.Fullstendig referanse
GenderAPI-feilkoder
Verdiene nedenfor samsvarer med den gjeldende offentlige GenderAPI-dokumentasjonen. Rett årsaken før du gjentar forespørselen.
access deniedForespørselen kom fra en IP-adresse eller referent uten tilgang.
invalid country codeLandverdien er ikke en støttet ISO 3166-1 alfa-2-kode.
name not set || email not set || username not setForespørselen mangler den påkrevde parameteren for navn, e-post eller brukernavn.
too many names || too many emails || too many usernamesForespørselen overskrider grensen: 100 navn, 50 e-postadresser eller 50 brukernavn.
query limit reachedAPI-nøkkelen har ingen gjenværende kreditter.
invalid or missing keyAPI-nøkkelen mangler eller ble ikke funnet.
API key has expiredPakken som er knyttet til API-nøkkelen, har utløpt.
Veiledning for feilhåndtering
Feil på en trygg måte og unngå blinde gjentakelser
Valider først
Avvis manglende inndata, ugyldige landkoder og for store grupper før de når API-et.
Beskytt API-nøkler
Oppbevar API-nøkler på serveren, og fjern dem fra applikasjonslogger, nettleserutdata og skjermbilder til kundestøtte.
Prøv på nytt selektivt
Disse feilene krever en rettelse eller handling på kontoen. Det løser ikke problemet å gjenta den samme forespørselen uendret.
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Hold diagnostiske detaljer private
Logg feilnummeret sammen med en intern forespørsels-ID, men aldri API-nøkkelen. Vis brukeren en kort og handlingsrettet melding i stedet for å eksponere nøkler eller interne forespørselsdata.
Dokumentasjonen er fullført