Virhevastauksen rakenne
Lue virheobjekti
Kun pyyntö epäonnistuu, JSON-vastaus palauttaa status-arvoksi false. Käytä numeeristaerrno-arvoa sovelluslogiikassa ja säilytä errmsg lokeja tai luettavaa diagnostiikkaa varten.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errno-arvon, ei errmsg-kentän tarkan tekstin perusteella. Näin integraatio pysyy ennakoitavana, vaikka seliteteksti myöhemmin muuttuisi.Täydellinen viite
GenderAPI-virhekoodit
Alla olevat arvot vastaavat nykyistä julkista GenderAPI-dokumentaatiota. Korjaa syy ennen pyynnön lähettämistä uudelleen.
access deniedPyyntö saapui IP-osoitteesta tai viittaajalta, jolla ei ole käyttöoikeutta.
invalid country codeMaa-arvo ei ole tuettu ISO 3166-1 alpha-2 -koodi.
name not set || email not set || username not setPyynnöstä puuttuu pakollinen nimi-, sähköposti- tai käyttäjänimiparametri.
too many names || too many emails || too many usernamesPyyntö ylittää rajan: 100 nimeä, 50 sähköpostiosoitetta tai 50 käyttäjänimeä.
query limit reachedAPI-avaimella ei ole jäljellä krediittejä.
invalid or missing keyAPI-avain puuttuu tai sitä ei löytynyt.
API key has expiredAPI-avaimeen liitetty paketti on vanhentunut.
Virheenkäsittelyn ohjeistus
Epäonnistu turvallisesti ja vältä sokeita uudelleenyrityksiä
Validoi ensin
Hylkää puuttuvat syötteet, virheelliset maakoodit ja liian suuret erät ennen API-kutsua.
Suojaa API-avaimet
Säilytä API-avaimet palvelimella ja poista ne sovelluslokeista, selaimen tulosteista sekä asiakastuelle lähetettävistä kuvakaappauksista.
Yritä uudelleen valikoivasti
Nämä virheet edellyttävät korjausta tai tilitoimenpidettä. Saman muuttamattoman pyynnön toistaminen ei ratkaise ongelmaa.
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Pidä diagnostiikkatiedot yksityisinä
Kirjaa virhenumero sisäisen pyyntötunnuksen kanssa, mutta älä koskaan API-avainta. Näytä käyttäjälle lyhyt ja toimintaan ohjaava viesti paljastamatta avaimia tai sisäisiä pyyntötietoja.
Dokumentaatio on valmis