Vad säger en e-postadress?
Skicka en syntaktiskt giltig e-postadress med type: email. GenderAPI.io letar efter en namnsignal i delen före @ och returnerar sedan en strukturerad prediktion. Brevlådan verifieras inte, den kopplas inte till någon innehavare och innehavarens könsidentitet fastställs inte.
Matchningen mot datamängden härleder kandidater ur adressens delar och kan kontrollera begränsade delsträngar. Smeknamnsläget behåller matchningen av hela delar men lägger inte till sådana delsträngskandidater. Om flera poster matchar väljs kandidaten med det största lagrade totala antalet, och det behöver inte vara det avsedda förnamnet. Granska data.name och data.match innan du använder ett extraherat namn i ett kontaktregister.
| Exempel på indata | Tolkning |
|---|---|
alice.smith@example.com | Den lokala delen innehåller möjliga namndelar. En träff är möjlig, men indata avgör inte i sig vilken kandidat som väljs. |
alice+news@example.com | Sökningen i datamängden tar bort tillägget efter plustecknet för sina kandidater. AI instrueras att bortse från det men får det skickade värdet. |
support@example.com | En funktionsadress ger ingen tillförlitlig signal om ett personnamn. Tilldela inte hela den delade brevlådan en persons kön. |
prenses@example.com | Det valfria forceToGenderize tillåter ett försök utifrån ett smeknamns betydelse när datamängden inte ger något resultat. Ett riktigt namn krävs inte i det läget. |
not-an-email | Ogiltig syntax ger ett valideringsfel i stället för ett lyckat okänt resultat. |
Skicka en e-postsökning från din applikation
Exemplet använder din befintliga API-nyckel i Bearer-rubriken och anger fallback uttryckligen. Ersätt exempeladressen med indata som du har rätt att behandla. Ange country bara när du har relevant kontext; e-postdomänen visar inte var en person befinner sig. Utan landskontext utelämnar du fältet.
Kör exemplet på din server när du har satt GENDERAPI_API_KEY. POST håller e-postadressen borta från förfrågans URL. Liveresultatet kan skilja sig från exempelsvaret i demon.
Välj ett programmeringsspråk. Konfigurera din API-nyckel, kör sedan exemplet på din server.
Varje prediktionsförfrågan är en ny debiterbar åtgärd, även vid nya försök. Exemplen gör inga automatiska nya försök. Kontrollera debiteringsstatus innan du skickar en ny förfrågan.
Innan du kör: åtkomst och felhantering
Kör exemplen på din server. Sätt GENDERAPI_API_KEY i processmiljön till din befintliga API-nyckel. Kontrollera att meta.access.mode är api_key: en nyckel som inte känns igen kan leda till IP-provperioden.
Vid JSON-svar med HTTP 4xx och 5xx behålls felinnehållet och exemplet avslutas med en slutstatus som inte är noll. Kontrollera code, action och meta.usage.billing_status innan du försöker igen.
Guide om fel och nya försök →cURL 7.76+ i ett POSIX-skal. Kör i terminalen. Dokumentation för körmiljön
Node.js 22+; inbyggd fetch. Spara som example.mjs och kör node example.mjs. Dokumentation för körmiljön
Python 3.10+; standardbiblioteket. Spara som example.py och kör python3 example.py. Dokumentation för körmiljön
PHP 8+ med tillägget cURL. Spara som example.php och kör php example.php. Dokumentation för körmiljön
Java 17+; inbyggd HTTP-klient. Spara som GenderApiExample.java och kör java GenderApiExample.java. Dokumentation för körmiljön
Konsolapplikation med .NET 8+. Använd som Program.cs i ett konsolprojekt och kör sedan dotnet run. Dokumentation för körmiljön
Go 1.22+; standardbiblioteket. Spara som main.go och kör go run main.go. Dokumentation för körmiljön
Spara resultatet tillsammans med underlaget
En härledd koppling är inte det kön som en person själv uppger. Spara ursprungliga indata, det returnerade underlaget och det personen själv har angett separat. Ett okänt resultat är ett giltigt resultat och bör inte bli en gissad kategori i din applikation.
| Fält | Användning |
|---|---|
data.gender / data.result_status | Använd male eller female bara vid identified. Behåll det inbyggda JSON-värdet null vid ett okänt resultat. |
data.name / data.match | Granska det returnerade namnet och den valda kandidaten. En träff på en delsträng visar inte att indata tillhör en person med det förnamnet. |
data.confidence / data.confidence_kind | Konfidensen ligger på en skala från 0 till 1 eller är null. observed_frequency bygger på lagrade frekvenser; model_reported är ett AI-värde. Utvärdera tröskelvärden separat för varje typ. |
data.source / data.sample_count | Skilj mellan dataset, ai och none. AI-resultat har ingen lagrad urvalsstorlek. En urvalsstorlek är inget uppmätt noggrannhetsvärde. |
meta.access.mode | Kontrollera att api_key rapporteras i en kontointegration. Nycklar som saknas eller inte känns igen kan i stället använda den delade IP-provperioden. |
meta.usage | Läs charged_credits och billing_status. Ett lyckat okänt resultat debiteras. Ett förlorat svar visar inte att förfrågan var kostnadsfri. |
Bestäm när AI ska användas
forceToGenderize är valfritt för namn, e-postadresser och användarnamn. När det är aktiverat utelämnar du ai_mode eller använder fallback; off och always kan inte kombineras med det och ger 422. Ett positivt startsaldo räcker för att starta en förfrågan, även om den slutliga debiteringen gör saldot negativt.
Smeknamnsläget kan returnera ett kön tillsammans med name: null. Det kan också ge ett okänt resultat. Varken vanlig AI-reserv eller tolkning av smeknamn garanterar ett korrekt svar eller ett värde som inte är null.
| Alternativ i förfrågan | Beteende | Krediter för en lyckad sökning |
|---|---|---|
| options.ai_mode: off | Använd bara datamängden. | 1, även för ett okänt resultat |
| options.ai_mode: fallback | Kontrollera datamängden först och använd sedan vanlig AI om inget kön returneras. Detta är standard för enskilda förfrågningar. | Totalt 1, inklusive AI-reserv |
| options.ai_mode: always | Använd AI direkt. | 2 |
| forceToGenderize: true | Kontrollera datamängden först och låt sedan AI tolka ett personligt smeknamn eller alias, även utan ett riktigt förnamn. | 1 för ett resultat som fastställs i datamängden; totalt 2 om AI används |
Bearbeta en e-postlista i batchar
Använd POST /api/v2/gender/batch med en items-array av poster med type: email. Åtkomst med en registrerad API-nyckel stöder upp till 50 poster och IP-provperioden upp till 10. Behåll ett unikt id för varje post så att du kan koppla resultaten till den ursprungliga raden. Svaret följer dessutom indataordningen och anger index.
Poster i en batch använder som standard bara datamängden. Ange options.ai_mode: fallback för varje post som behöver vanlig AI-reserv. Två lyckade poster med fallback kostar totalt 2 krediter, även när resultaten är okända; en HTTP-förfrågan motsvarar inte en kredit per prediktion.
Kontrollera varje post, även när batchen returnerar HTTP 200. Spara lyckade och okända resultat och kontrollera sedan felen och den bekräftade debiteringen innan du skickar om misslyckade poster. Skicka inte om en lyckad batch i sin helhet efter en överskriden tidsgräns utan att först kontrollera debiteringen.
Veta vad du skickar
Livedemon skickar det inmatade värdet till GenderAPI.io först när du skickar in det. Om AI används skickas den inskickade type, value och landskontexten till den konfigurerade tjänsten för prediktioner. För en prediktion som bara använder datamängden anger du options.ai_mode: off utan forceToGenderize i din integration.
Integritetspolicyn, personuppgiftsbiträdesavtalet och förteckningen över underbiträden beskriver de publicerade villkoren för behandlingen. Ett resultat är en härledd koppling, och det en person själv uppger har företräde. Använd det inte som grund för beslut med stora konsekvenser för en person.
Vanliga frågor
Kan API:et extrahera ett förnamn ur en e-postadress?
Det kan returnera en namnkandidat när den lokala delen innehåller en användbar signal. Både träffar på hela delar och på delsträngar är möjliga, så granska data.match. Resultatet visar inte förnamnet på den person som äger brevlådan.
Ger info@ eller support@ ett kön?
Delade funktionsadresser ger oftast inget underlag för ett personnamn. Ett okänt resultat är giltigt. AI eller smeknamnsläget ska inte ses som en bekräftelse för de personer som använder en delad brevlåda.
Förbrukar ett okänt resultat för en e-postadress krediter?
Ja. En lyckad vanlig e-postsökning kostar 1 kredit, inklusive AI-reserv och okända resultat. Framtvingad tolkning av smeknamn kostar 1 kredit för ett resultat som fastställs i datamängden eller totalt 2 om AI används. För fel redovisas debiteringen separat i meta.usage.
Tas e-postdomänen bort innan AI behandlar adressen?
Det utlovas inte. Kandidaterna i datamängden kommer från den lokala delen, medan AI får det skickade värdet och instrueras att bortse från domänen och tillägget efter plustecknet. Använd läget som bara använder datamängden om ditt arbetsflöde kräver det.