Feilreferanse

Håndter API-feil på en forutsigbar måte

Identifiser mislykkede GenderAPI-forespørsler med den stabile errno-verdien, og velg riktig tiltak.

Kontroller førststatus: falseerrnoerrmsg

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.

JSON · eksempel på feil
{
  "status": false,
  "errno": 94,
  "errmsg": "invalid or missing key"
}
Implementeringsregel: Styr logikken etter 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.

errno50
access denied

Forespørselen kom fra en IP-adresse eller referent uten tilgang.

Kontroller tilgangsbegrensningene som er knyttet til API-nøkkelen.
errno90
invalid country code

Landverdien er ikke en støttet ISO 3166-1 alfa-2-kode.

Valider og normaliser landkoden før du prøver på nytt.
errno91
name not set || email not set || username not set

Forespørselen mangler den påkrevde parameteren for navn, e-post eller brukernavn.

Legg til påkrevd inndata for endepunktet som kalles.
errno92
too many names || too many emails || too many usernames

Forespørselen overskrider grensen: 100 navn, 50 e-postadresser eller 50 brukernavn.

Del inndataene i mindre grupper og send dem separat.
errno93
query limit reached

API-nøkkelen har ingen gjenværende kreditter.

Sett oppslagsjobber på pause og fyll på kontosaldoen.
errno94
invalid or missing key

API-nøkkelen mangler eller ble ikke funnet.

Kontroller innsettingen av nøkkelen og bruk en gyldig nøkkel på serversiden.
errno99
API key has expired

Pakken som er knyttet til API-nøkkelen, har utløpt.

Forny pakken før du sender et nytt oppslag.

Veiledning for feilhåndtering

Feil på en trygg måte og unngå blinde gjentakelser

01

Valider først

Avvis manglende inndata, ugyldige landkoder og for store grupper før de når API-et.

02

Beskytt API-nøkler

Oppbevar API-nøkler på serveren, og fjern dem fra applikasjonslogger, nettleserutdata og skjermbilder til kundestøtte.

03

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.

TypeScript · kontroll av svar
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

Fortsett å bygge med GenderAPI

Bruk og kvoteOvervåk tilgjengelige kreditter →PriserSammenlign kredittpakker →