GenderAPI-fejlkoder

Svarkontrakt

Læs fejlobjektet

Når en anmodning mislykkes, returnerer JSON-svaret status som false. Brug den numeriskeerrno i applikationslogikken, og behold errmsg til logning eller læsevenlig diagnostik.

JSON · eksempel på fejl

{
  "status": false,
  "errno": 94,
  "errmsg": "invalid or missing key"
}

Implementeringsregel: Forgren programlogikken på errno, ikke den nøjagtige formulering i errmsg. Så forbliver integrationen forudsigelig, hvis forklaringsteksten senere ændres.

Komplet reference

Følgende værdier svarer til den aktuelle offentlige GenderAPI-dokumentation. Ret årsagen, før anmodningen gentages.

errno50

access denied

Anmodningen kom fra en IP-adresse eller referrer uden adgang.

Kontrollér adgangsbegrænsningerne, der er knyttet til API-nøglen.

errno90

invalid country code

Landeværdien er ikke en understøttet ISO 3166-1 alpha-2-kode.

Validér og normalisér landekoden, før du prøver igen.

errno91

name not set || email not set || username not set

Anmodningen mangler den påkrævede parameter name, email eller username.

Tilføj det input, som det kaldte endpoint kræver.

errno92

too many names || too many emails || too many usernames

Anmodningen overskrider batchgrænsen: 100 navne, 50 e-mailadresser eller 50 brugernavne.

Opdel inputtet i mindre batches, og send dem separat.

errno93

query limit reached

API-nøglen har ingen kreditter tilbage.

Sæt opslagsjobs på pause, og fyld kontoens kreditbeholdning op.

errno94

invalid or missing key

API-nøglen mangler eller kan ikke findes.

Kontrollér, hvordan legitimationsoplysningerne tilføres, og brug en gyldig nøgle på serversiden.

errno99

API key has expired

Pakken, der er knyttet til API-nøglen, er udløbet.

Forny pakken, før du sender et nyt opslag.

Principper for håndtering

Håndter fejl sikkert, og undgå ukritiske genforsøg

Validér først

Afvis manglende input, ugyldige landekoder og for store batches, før de når API’et.

Beskyt legitimationsoplysninger

Opbevar API-nøgler på serveren, og skjul dem i applikationslogs, browseroutput og skærmbilleder til support.

Prøv igen selektivt

Disse fejl kræver en rettelse eller en kontohandling. Den samme uændrede anmodning løser ikke problemet.

TypeScript · svarkontrol

type GenderApiError = {
  status: false;
  errno: number;
  errmsg: string;
};

if (response.status === false) {
  handleGenderApiError(response.errno, response.errmsg);
}

Hold diagnostiske oplysninger private

Log fejlnummeret sammen med et internt anmodnings-ID, men aldrig API-nøglen. Vis brugeren en kort og handlingsrettet besked i stedet for rå legitimationsoplysninger eller interne anmodningsdata.

Dokumentationen er komplet

Fortsæt med at bygge med GenderAPI

Brug og kvoteOvervåg tilgængelige kreditter →PriserSammenlign kreditpakker →

Håndter API-fejl pålideligt

Læs fejlobjektet