Hva forteller en e-postadresse?
Send en syntaktisk gyldig e-postadresse med type: email. GenderAPI.io ser etter et navnesignal i delen foran @ og returnerer deretter en strukturert prediksjon. Postkassen blir ikke verifisert, den blir ikke knyttet til en innehaver, og innehaverens kjønnsidentitet blir ikke fastslått.
Treff i datasettet henter kandidater fra delene av adressen og kan kontrollere et begrenset antall delstrenger. Kallenavnmodus beholder treff på hele deler, men legger ikke til disse kandidatene basert på delstrenger. Hvis flere oppføringer gir treff, velges kandidaten med det høyeste lagrede totalantallet, og det er ikke nødvendigvis det tiltenkte fornavnet. Kontroller data.name og data.match før du bruker et uttrukket navn i et kontaktregister.
| Eksempel på inndata | Tolkning |
|---|---|
alice.smith@example.com | Den lokale delen inneholder mulige navnedeler. Et treff er mulig, men inndataene alene avgjør ikke hvilken kandidat som velges. |
alice+news@example.com | Oppslaget i datasettet fjerner suffikset etter plusstegnet for sine egne kandidater. KI blir bedt om å se bort fra det, men mottar verdien som ble sendt. |
support@example.com | En rolleadresse gir ikke et pålitelig signal om et personnavn. Ikke tilskriv hele den delte postkassen kjønnet til én person. |
prenses@example.com | Det valgfrie alternativet forceToGenderize tillater et forsøk basert på betydningen av et kallenavn når datasettet ikke gir et resultat. I denne modusen trengs det ikke et ekte navn. |
not-an-email | Ugyldig syntaks gir en valideringsfeil i stedet for et vellykket ukjent resultat. |
Send en forespørsel for en e-postadresse fra applikasjonen din
Eksemplet bruker din eksisterende API-nøkkel i Bearer-headeren og angir fallback eksplisitt. Erstatt eksempeladressen med inndata du har rett til å behandle. Angi country bare når du har relevant kontekst; e-postdomenet viser ikke hvor en person befinner seg. Uten landkontekst utelater du feltet.
Kjør eksemplet på serveren din etter at du har satt GENDERAPI_API_KEY. Med POST holdes e-postadressen utenfor URL-en til forespørselen. Resultatet i sanntid kan avvike fra eksempelsvaret i demoen.
Velg et programmeringsspråk. Konfigurer API-nøkkelen, og kjør deretter eksemplet på serveren din.
Hver prediksjonsforespørsel er en ny operasjon som belastes, også nye forsøk. Disse eksemplene prøver ikke automatisk på nytt. Sjekk belastningsstatusen før du sender en ny forespørsel.
Før du kjører: tilgang og feilhåndtering
Kjør disse eksemplene på serveren din. Sett GENDERAPI_API_KEY i prosessmiljøet til din eksisterende API-nøkkel. Bekreft at meta.access.mode er api_key: en nøkkel som ikke gjenkjennes, kan føre til IP-prøveperioden.
Ved JSON-svar med HTTP 4xx og 5xx beholdes feilinnholdet, og eksemplet avsluttes med en exit-status som ikke er null. Sjekk code, action og meta.usage.billing_status før du prøver på nytt.
Veiledning om feil og nye forsøk →cURL 7.76+ i et POSIX-skall. Kjør i terminalen. Dokumentasjon for kjøretidsmiljøet
Node.js 22+; innebygd fetch. Lagre som example.mjs og kjør node example.mjs. Dokumentasjon for kjøretidsmiljøet
Python 3.10+; standardbiblioteket. Lagre som example.py og kjør python3 example.py. Dokumentasjon for kjøretidsmiljøet
PHP 8+ med cURL-utvidelsen. Lagre som example.php og kjør php example.php. Dokumentasjon for kjøretidsmiljøet
Java 17+; standard HTTP-klient. Lagre som GenderApiExample.java og kjør java GenderApiExample.java. Dokumentasjon for kjøretidsmiljøet
Konsollapplikasjon i .NET 8+. Bruk som Program.cs i et konsollprosjekt, og kjør deretter dotnet run. Dokumentasjon for kjøretidsmiljøet
Go 1.22+; standardbiblioteket. Lagre som main.go og kjør go run main.go. Dokumentasjon for kjøretidsmiljøet
Lagre resultatet sammen med grunnlaget
En utledet tilknytning er ikke det kjønnet en person selv har oppgitt. Lagre de opprinnelige inndataene, grunnlaget som ble returnert, og det personen selv har oppgitt, hver for seg. Et ukjent resultat er et gyldig resultat og bør ikke bli en gjettet kategori i applikasjonen din.
| Felt | Bruk |
|---|---|
data.gender / data.result_status | Bruk male eller female bare sammen med identified. Ved et ukjent resultat beholder du den opprinnelige JSON-verdien null. |
data.name / data.match | Kontroller det returnerte navnet og den valgte kandidaten. Et treff på en delstreng beviser ikke at inndataene tilhører en person med dette navnet. |
data.confidence / data.confidence_kind | Konfidensen er en verdi fra 0 til 1 eller null. observed_frequency bygger på lagrede frekvenser; model_reported er en verdi fra KI. Evaluer tersklene separat for hver type. |
data.source / data.sample_count | Skill mellom dataset, ai og none. KI-resultater har ingen lagret utvalgsstørrelse. En utvalgsstørrelse er ikke en målt nøyaktighet. |
meta.access.mode | Kontroller at api_key rapporteres i en integrasjon med konto. Nøkler som mangler eller ikke gjenkjennes, kan i stedet bruke den delte IP-prøveperioden. |
meta.usage | Les charged_credits og billing_status. Et vellykket ukjent resultat belastes. Et tapt svar beviser ikke at forespørselen var gratis. |
Bestem når KI skal brukes
forceToGenderize er valgfritt for navn, e-postadresser og brukernavn. Når det er aktivert, utelater du ai_mode eller bruker fallback; off og always kan ikke kombineres med dette alternativet og gir 422. En positiv startsaldo er nok til å starte en forespørsel, selv om den endelige belastningen gjør saldoen negativ.
Kallenavnmodus kan returnere et kjønn sammen med name: null. Den kan også gi et ukjent resultat. Verken vanlig KI-reserve eller tolkning av kallenavn garanterer et riktig svar eller en verdi som ikke er null.
| Alternativ i forespørselen | Virkemåte | Kreditter for et vellykket oppslag |
|---|---|---|
| options.ai_mode: off | Bruker bare datasettet. | 1, også for et ukjent resultat |
| options.ai_mode: fallback | Søker først i datasettet og bruker deretter vanlig KI hvis det ikke returneres et kjønn. Dette er standard for enkeltforespørsler. | 1 totalt, inkludert KI-reserve |
| options.ai_mode: always | Bruker KI direkte. | 2 |
| forceToGenderize: true | Søker først i datasettet og lar deretter KI tolke et personlig kallenavn eller alias, selv uten et ekte fornavn. | 1 for et resultat fra datasettet; 2 totalt hvis KI brukes |
Behandle en liste med e-postadresser i en samleforespørsel
Bruk POST /api/v2/gender/batch med en items-matrise av elementer med type: email. Tilgang med en registrert API-nøkkel støtter opptil 50 elementer, IP-prøveperioden opptil 10. Gi hvert element en unik id, slik at du kan koble resultatene til den opprinnelige raden. Svaret følger dessuten rekkefølgen i inndataene og oppgir index.
Som standard bruker elementer i en samleforespørsel bare datasettet. Angi options.ai_mode: fallback for hvert element som trenger vanlig KI-reserve. To vellykkede elementer med fallback koster 2 kreditter totalt, også når resultatene er ukjente; én HTTP-forespørsel tilsvarer ikke én kreditt per prediksjon.
Kontroller hvert element, også når samleforespørselen returnerer HTTP 200. Lagre vellykkede og ukjente resultater, og kontroller deretter feil og bekreftet belastning før du sender mislykkede elementer på nytt. Etter et tidsavbrudd må du ikke sende en vellykket samleforespørsel på nytt i sin helhet uten først å ha sjekket belastningen.
Vit hva du sender
Demoen i sanntid sender verdien du skriver inn, til GenderAPI.io bare når du selv sender den. Hvis KI brukes, overføres type, value og landkonteksten som ble sendt, til tjenesten som er konfigurert for prediksjoner. For en prediksjon som bare bruker datasettet, angir du options.ai_mode: off uten forceToGenderize i integrasjonen din.
Personvernerklæringen, databehandleravtalen og listen over underdatabehandlere beskriver de publiserte vilkårene for behandlingen. Et resultat er en utledet tilknytning, og det en person selv oppgir, har forrang. Ikke bruk det som grunnlag for beslutninger som har store konsekvenser for en person.
Vanlige spørsmål
Kan API-et hente ut et fornavn fra en e-postadresse?
Det kan returnere en navnekandidat når den lokale delen inneholder et brukbart signal. Både treff på hele deler og på delstrenger er mulig, så kontroller data.match. Resultatet viser ikke fornavnet til personen som eier postkassen.
Gir en adresse som info@ eller support@ et kjønn?
Delte rolleadresser gir vanligvis ikke grunnlag for et personnavn. Et ukjent resultat er gyldig. KI eller kallenavnmodus skal ikke regnes som en bekreftelse for personene som bruker en delt postkasse.
Bruker et ukjent resultat for en e-postadresse kreditter?
Ja. En vanlig vellykket forespørsel for en e-postadresse koster 1 kreditt, inkludert KI-reserve og ukjente resultater. Tvunget tolkning av kallenavn koster 1 kreditt for et resultat fra datasettet eller 2 totalt hvis KI brukes. Ved en feil vises belastningen separat i meta.usage.
Fjernes e-postdomenet før KI behandler adressen?
Det er ikke garantert. Kandidatene i datasettet kommer fra den lokale delen, mens KI mottar verdien som ble sendt, med beskjed om å se bort fra domenet og suffikset etter plusstegnet. Bruk modusen med bare datasettet hvis arbeidsflyten din krever det.