Wat zegt een e-mailadres?
Verstuur een syntactisch geldig e-mailadres met type: email. GenderAPI.io zoekt naar een naamsignaal in het deel vóór de @ en geeft daarna een gestructureerde voorspelling terug. De mailbox wordt niet gecontroleerd, niet aan een eigenaar gekoppeld en de genderidentiteit van de eigenaar wordt niet vastgesteld.
De match met de dataset haalt kandidaten uit de delen van het adres en kan beperkte delen van tekenreeksen controleren. De bijnaammodus behoudt de match op hele delen, maar voegt deze kandidaten op basis van delen van tekenreeksen niet toe. Komen meerdere items overeen, dan wordt de kandidaat met de hoogste opgeslagen totale telling gekozen, en dat is niet per se de bedoelde voornaam. Controleer data.name en data.match voordat u een gevonden naam in een contactrecord gebruikt.
| Voorbeeldinvoer | Interpretatie |
|---|---|
alice.smith@example.com | Het lokale deel bevat mogelijke delen van een naam. Een match is mogelijk, maar de invoer alleen bepaalt niet welke kandidaat wordt gekozen. |
alice+news@example.com | De zoekopdracht in de dataset verwijdert voor de eigen kandidaten het achtervoegsel na het plusteken. AI wordt gevraagd dat te negeren, maar ontvangt de verstuurde waarde. |
support@example.com | Een functieadres geeft geen betrouwbaar signaal van een persoonsnaam. Ken aan een gedeelde mailbox niet het geslacht van één persoon toe. |
prenses@example.com | Met de optionele instelling forceToGenderize is een poging op basis van de betekenis van een bijnaam mogelijk als de dataset geen resultaat oplevert. In deze modus is geen echte naam nodig. |
not-an-email | Een ongeldige syntaxis geeft een validatiefout terug in plaats van een geslaagd onbekend resultaat. |
Een verzoek voor een e-mailadres versturen vanuit uw applicatie
Het voorbeeld gebruikt uw bestaande API-sleutel in de Bearer-header en geeft fallback expliciet op. Vervang het voorbeeldadres door invoer die u mag verwerken. Geef country alleen op als u over relevante context beschikt; het e-maildomein laat niet zien waar iemand zich bevindt. Laat het veld weg als er geen landcontext is.
Voer het voorbeeld uit op uw server nadat u GENDERAPI_API_KEY hebt ingesteld. Met POST blijft het e-mailadres buiten de URL van het verzoek. Het live resultaat kan afwijken van het voorbeeldantwoord in de demo.
Kies een programmeertaal. Stel uw API-sleutel in, voer daarna het voorbeeld uit op uw server.
Elk voorspellingsverzoek is een nieuwe betaalde bewerking, ook als het een nieuwe poging is. Deze voorbeelden proberen het niet automatisch opnieuw. Controleer de afschrijvingsstatus voordat u een nieuw verzoek verstuurt.
Voordat u het uitvoert: toegang en foutafhandeling
Voer deze voorbeelden uit op uw server. Stel in de procesomgeving GENDERAPI_API_KEY in op uw bestaande API-sleutel. Controleer of meta.access.mode api_key is: een niet-herkende sleutel kan terugvallen op de IP-proefperiode.
Bij JSON-antwoorden met HTTP 4xx en 5xx blijft de body van de fout behouden en eindigt het voorbeeld met een afsluitcode die niet nul is. Controleer code, action en meta.usage.billing_status voordat u het opnieuw probeert.
Handleiding voor fouten en nieuwe pogingen →cURL 7.76+ in een POSIX-shell. Voer uit in uw terminal. Documentatie van de runtime
Node.js 22+; ingebouwde fetch. Sla op als example.mjs en voer node example.mjs uit. Documentatie van de runtime
Python 3.10+; standaardbibliotheek. Sla op als example.py en voer python3 example.py uit. Documentatie van de runtime
PHP 8+ met de cURL-extensie. Sla op als example.php en voer php example.php uit. Documentatie van de runtime
Java 17+; standaard HTTP-client. Sla op als GenderApiExample.java en voer java GenderApiExample.java uit. Documentatie van de runtime
.NET 8+-consoleapplicatie. Gebruik als Program.cs in een consoleproject en voer daarna dotnet run uit. Documentatie van de runtime
Go 1.22+; standaardbibliotheek. Sla op als main.go en voer go run main.go uit. Documentatie van de runtime
Het resultaat samen met het bewijs opslaan
Een afgeleide koppeling is niet het geslacht dat iemand zelf opgeeft. Sla de oorspronkelijke invoer, het teruggegeven bewijs en wat de persoon zelf heeft opgegeven apart op. Een onbekend resultaat is een geldig resultaat en mag in uw applicatie geen geraden categorie worden.
| Veld | Gebruik |
|---|---|
data.gender / data.result_status | Gebruik male of female alleen bij identified. Bewaar bij een onbekend resultaat de oorspronkelijke JSON-waarde null. |
data.name / data.match | Controleer de teruggegeven naam en de geselecteerde kandidaat. Een match op een deel van de tekenreeks bewijst niet dat de invoer bij een persoon met die naam hoort. |
data.confidence / data.confidence_kind | De betrouwbaarheidsscore staat op een schaal van 0 tot 1 of is null. observed_frequency is gebaseerd op opgeslagen frequenties; model_reported is een waarde die AI opgeeft. Evalueer drempels per soort afzonderlijk. |
data.source / data.sample_count | Maak onderscheid tussen dataset, ai en none. AI-resultaten hebben geen opgeslagen steekproefgrootte. Een steekproefgrootte is geen gemeten nauwkeurigheid. |
meta.access.mode | Controleer bij een integratie met een account of api_key wordt vermeld. Ontbrekende of niet-herkende sleutels kunnen anders de gedeelde IP-proefperiode gebruiken. |
meta.usage | Lees charged_credits en billing_status. Een geslaagd onbekend resultaat wordt afgeschreven. Een verloren antwoord bewijst niet dat het verzoek gratis was. |
Bepalen wanneer u AI gebruikt
forceToGenderize is optioneel voor namen, e-mailadressen en gebruikersnamen. Als het is ingeschakeld, laat ai_mode dan weg of gebruik fallback; off en always kunnen niet met deze optie worden gecombineerd en geven 422 terug. Een positief beginsaldo is genoeg om een verzoek te starten, ook als de uiteindelijke afschrijving het saldo negatief maakt.
De bijnaammodus kan een geslacht teruggeven samen met name: null. Ook een onbekend resultaat is mogelijk. Noch de normale AI-fallback noch de bijnaaminterpretatie garandeert een juist antwoord of een waarde anders dan null.
| Optie in het verzoek | Werking | Credits per geslaagde zoekopdracht |
|---|---|---|
| options.ai_mode: off | Gebruikt alleen de dataset. | 1, ook bij een onbekend resultaat |
| options.ai_mode: fallback | Raadpleegt eerst de dataset en gebruikt daarna de normale AI als er geen geslacht wordt teruggegeven. Dit is de standaardwaarde voor losse verzoeken. | In totaal 1, inclusief AI-fallback |
| options.ai_mode: always | Gebruikt direct AI. | 2 |
| forceToGenderize: true | Raadpleegt eerst de dataset en laat daarna AI een persoonlijke bijnaam of alias interpreteren, ook zonder echte voornaam. | 1 voor een resultaat uit de dataset; in totaal 2 als AI wordt gebruikt |
Een lijst met e-mailadressen in batches verwerken
Gebruik POST /api/v2/gender/batch met een items-array van items met type: email. Toegang met een geregistreerde API-sleutel ondersteunt maximaal 50 items, de IP-proefperiode maximaal 10. Geef elk item een unieke id, zodat u de resultaten aan de oorspronkelijke rij kunt koppelen. Het antwoord volgt bovendien de invoervolgorde en vermeldt index.
Standaard gebruiken items in een batch alleen de dataset. Stel options.ai_mode: fallback in voor elk item dat de normale AI-fallback nodig heeft. Twee geslaagde items met fallback kosten in totaal 2 credits, ook als de resultaten onbekend zijn; één HTTP-verzoek staat niet gelijk aan één credit per voorspelling.
Controleer elk item, ook als de batch HTTP 200 teruggeeft. Sla geslaagde en onbekende resultaten op en controleer daarna de fouten en de bevestigde afschrijving voordat u mislukte items opnieuw verstuurt. Verstuur na een time-out een geslaagde batch niet volledig opnieuw zonder eerst de afschrijving te controleren.
Weten wat u verstuurt
De live demo verstuurt de ingevoerde waarde pas naar GenderAPI.io wanneer u die zelf verstuurt. Als AI wordt gebruikt, worden type, value en de verstuurde landcontext doorgegeven aan de dienst die voor voorspellingen is geconfigureerd. Stel voor een voorspelling die alleen de dataset gebruikt in uw integratie options.ai_mode: off in zonder forceToGenderize.
Het privacybeleid, de verwerkersovereenkomst en de lijst met subverwerkers beschrijven de gepubliceerde voorwaarden voor de verwerking. Een resultaat is een afgeleide koppeling en wat iemand zelf opgeeft, gaat altijd voor. Gebruik het niet als basis voor beslissingen met belangrijke gevolgen voor een persoon.
Veelgestelde vragen
Kan de API een voornaam uit een e-mailadres halen?
De API kan een kandidaat voor een naam teruggeven als het lokale deel een bruikbaar signaal bevat. Er zijn matches op hele delen en op delen van tekenreeksen mogelijk, dus controleer data.match. Het resultaat vertelt niet wat de voornaam is van de persoon die de mailbox gebruikt.
Geeft een adres als info@ of support@ een geslacht terug?
Gedeelde functieadressen bevatten meestal geen bewijs van een persoonsnaam. Een onbekend resultaat is geldig. Beschouw AI of de bijnaammodus niet als bevestiging voor de personen die een gedeelde mailbox gebruiken.
Kost een onbekend resultaat voor een e-mailadres credits?
Ja. Een normaal geslaagd verzoek voor een e-mailadres kost 1 credit, inclusief de AI-fallback en onbekende resultaten. De geforceerde bijnaaminterpretatie kost 1 credit voor een resultaat uit de dataset of in totaal 2 als AI wordt gebruikt. Bij een fout wordt de afschrijving apart vermeld in meta.usage.
Wordt het e-maildomein verwijderd voordat AI het adres verwerkt?
Dat is niet gegarandeerd. De kandidaten voor de dataset komen uit het lokale deel, terwijl AI de verstuurde waarde ontvangt met de instructie het domein en het achtervoegsel na het plusteken te negeren. Gebruik de modus met alleen de dataset als uw werkproces dat vereist.