Que peut révéler une adresse e-mail ?
Envoyez une adresse syntaxiquement valide avec type: email. GenderAPI.io recherche un indice de nom dans la partie située avant @, puis renvoie une estimation structurée. L’API ne vérifie ni l’existence de la boîte aux lettres, ni son titulaire, ni l’identité de genre de cette personne.
La recherche dans le jeu de données extrait des candidats et peut tester des fragments de longueur limitée. Le mode pseudonyme conserve la recherche par mots, mais n’ajoute pas ces fragments. Si plusieurs enregistrements correspondent, le candidat ayant l’effectif enregistré le plus élevé est retenu ; ce n’est pas forcément le prénom attendu. Vérifiez data.name et data.match avant d’utiliser un nom extrait dans une fiche de contact.
| Exemple d’entrée | Comment l’interpréter |
|---|---|
alice.smith@example.com | La partie avant @ fournit des candidats possibles. Une correspondance est possible, mais la valeur seule ne garantit pas quel candidat sera retenu. |
alice+news@example.com | La recherche supprime le suffixe commençant par + pour générer ses candidats. L’IA reçoit la valeur envoyée, avec la consigne d’ignorer ce suffixe. |
support@example.com | Une adresse fonctionnelle ne fournit pas d’indice fiable de nom personnel. N’attribuez pas le genre d’une personne à toute une boîte partagée. |
prenses@example.com | forceToGenderize permet une tentative fondée sur le sens du pseudonyme si le jeu de données ne résout pas la requête. Dans ce mode, un prénom réel n’est pas exigé. |
not-an-email | Une syntaxe invalide renvoie une erreur de validation, et non un résultat unknown abouti. |
Interrogez une adresse e-mail depuis votre application
L’exemple utilise votre clé API existante dans l’en-tête Bearer et sélectionne explicitement fallback. Remplacez l’adresse par une valeur que vous êtes autorisé à traiter. N’envoyez country que si vous disposez d’un contexte pertinent : le domaine de l’adresse ne prouve pas où vit une personne. Si vous ne connaissez pas le pays, omettez ce champ.
Définissez GENDERAPI_API_KEY et exécutez l’exemple sur votre serveur. POST maintient l’adresse e-mail hors de l’URL de la requête. Le résultat réel peut différer de la réponse illustrative affichée par l’outil.
Choisissez un langage de programmation. Configurez votre clé API, puis exécutez l'exemple sur votre serveur.
Chaque requête de prédiction est une nouvelle opération facturable, y compris les nouvelles tentatives. Ces exemples ne réessaient pas automatiquement. Vérifiez le statut de facturation avant d'envoyer une autre requête.
Avant l'exécution : accès et gestion des erreurs
Exécutez ces exemples sur votre serveur. Définissez GENDERAPI_API_KEY dans l'environnement du processus avec votre clé API existante. Vérifiez que meta.access.mode vaut api_key : une clé non reconnue peut basculer vers l'essai par IP.
Pour les réponses JSON HTTP 4xx et 5xx, les exemples conservent le corps de l'erreur et renvoient un code de sortie non nul. Vérifiez code, action et meta.usage.billing_status avant de réessayer.
Guide des erreurs et des nouvelles tentatives →cURL 7.76+ dans un shell POSIX. À exécuter dans votre terminal. Documentation de l'environnement d'exécution
Node.js 22+ ; fetch intégré. Enregistrez sous example.mjs et exécutez node example.mjs. Documentation de l'environnement d'exécution
Python 3.10+ ; bibliothèque standard. Enregistrez sous example.py et exécutez python3 example.py. Documentation de l'environnement d'exécution
PHP 8+ avec l'extension cURL. Enregistrez sous example.php et exécutez php example.php. Documentation de l'environnement d'exécution
Java 17+ ; client HTTP standard. Enregistrez sous GenderApiExample.java et exécutez java GenderApiExample.java. Documentation de l'environnement d'exécution
Application console .NET 8+. Utilisez-le comme Program.cs dans un projet console, puis exécutez dotnet run. Documentation de l'environnement d'exécution
Go 1.22+ ; bibliothèque standard. Enregistrez sous main.go et exécutez go run main.go. Documentation de l'environnement d'exécution
Conservez le résultat avec ses éléments de preuve
Une association déduite n’équivaut pas au genre déclaré par la personne. Conservez séparément la valeur d’origine, les éléments de preuve renvoyés et les informations fournies par la personne elle-même. unknown est un résultat valide : ne le transformez pas en une catégorie devinée dans votre application.
| Champ | Comment l’utiliser |
|---|---|
data.gender / data.result_status | Utilisez male ou female uniquement lorsque le résultat est identified. Conservez la valeur JSON null lorsqu’il est unknown. |
data.name / data.match | Vérifiez le nom renvoyé et le candidat retenu. Une correspondance partielle ne prouve pas que la valeur appartient à une personne portant ce prénom. |
data.confidence / data.confidence_kind | La confiance est exprimée entre 0 et 1, ou vaut null. observed_frequency provient des effectifs enregistrés ; model_reported est un score fourni par l’IA. Évaluez vos seuils séparément pour chaque type. |
data.source / data.sample_count | Distinguez dataset, ai et none. Les résultats de l’IA n’ont pas d’effectif enregistré. La taille de l’échantillon n’est pas une mesure d’exactitude. |
meta.access.mode | Vérifiez la valeur api_key pour une intégration liée à un compte. Si la clé est absente ou non reconnue, l’essai partagé par IP peut être utilisé à la place. |
meta.usage | Lisez charged_credits et billing_status. Un résultat unknown obtenu avec succès est facturé. L’absence de réponse ne prouve pas que la requête était gratuite. |
Choisissez quand utiliser l’IA
forceToGenderize est facultatif pour les noms, les adresses e-mail et les noms d’utilisateur. Lorsqu’il est activé, omettez ai_mode ou utilisez fallback : la combinaison avec off ou always renvoie une erreur 422. Un solde de départ positif suffit pour lancer une requête, même si le débit final fait passer le solde en dessous de zéro.
L’analyse des pseudonymes peut renvoyer un genre avec name: null. Elle peut aussi renvoyer unknown. Ni le repli IA standard ni l’analyse des pseudonymes ne garantissent une réponse correcte ou non nulle.
| Option de la requête | Comportement | Crédits par requête aboutie |
|---|---|---|
| options.ai_mode: off | Interroge uniquement le jeu de données. | 1 crédit, unknown compris |
| options.ai_mode: fallback | Interroge d’abord le jeu de données, puis l’IA standard si aucun genre n’est trouvé. C’est le mode par défaut des requêtes individuelles. | 1 crédit au total, repli IA compris |
| options.ai_mode: always | Interroge directement l’IA. | 2 crédits |
| forceToGenderize: true | Interroge d’abord le jeu de données ; si aucun genre n’est trouvé, autorise l’IA à interpréter le sens d’un surnom ou d’un pseudonyme personnel, même sans prénom réel. | 1 crédit si le jeu de données résout la requête ; 2 au total si l’IA est utilisée |
Traitez une liste d’adresses e-mail par lots
Utilisez POST /api/v2/gender/batch avec un tableau items d’entrées type: email. La limite est de 50 éléments avec une clé API et de 10 avec l’essai par IP. Attribuez un id unique à chaque élément pour rattacher le résultat à sa ligne d’origine. La réponse conserve aussi l’ordre d’entrée et indique index.
Par défaut, les éléments d’un lot utilisent uniquement le jeu de données. Ajoutez options.ai_mode: fallback à chaque élément qui nécessite le repli IA standard. Deux éléments fallback aboutis coûtent 2 crédits au total, résultats unknown compris ; une requête HTTP ne correspond pas à un seul crédit d’estimation.
Examinez chaque élément, même si le lot renvoie HTTP 200. Enregistrez les résultats identifiés et inconnus, puis vérifiez les erreurs et le débit confirmé avant de renvoyer les éléments en échec. Après un délai dépassé, vérifiez la facturation avant de renvoyer un lot complet.
Comprenez ce que vous envoyez
L’outil n’envoie la valeur saisie à GenderAPI.io que lorsque vous cliquez sur Analyser. Si l’IA intervient, le service d’inférence configuré reçoit type, value et le contexte pays envoyé. Pour une estimation fondée uniquement sur le jeu de données, utilisez options.ai_mode: off sans forceToGenderize dans votre intégration.
La Politique de confidentialité, l’accord de traitement des données et la liste des sous-traitants décrivent les conditions publiées. Le résultat est une association déduite : donnez la priorité aux informations fournies par la personne. Ne l’utilisez pas comme fondement de décisions ayant des conséquences importantes pour quelqu’un.
Questions fréquentes
L’API peut-elle extraire un prénom d’une adresse e-mail ?
Elle peut renvoyer un nom candidat si la partie avant @ contient un indice exploitable. Des correspondances par mots ou par fragments sont possibles : vérifiez donc data.match. Le résultat ne prouve pas le prénom du titulaire de la boîte aux lettres.
Une adresse info@ ou support@ renvoie-t-elle un genre ?
Les adresses fonctionnelles partagées ne fournissent généralement aucun indice de nom personnel. unknown est un résultat valide. L’IA ou le mode pseudonyme ne vérifient pas l’identité des personnes qui utilisent une boîte partagée.
Un résultat unknown consomme-t-il des crédits ?
Oui. Une requête e-mail standard aboutie coûte 1 crédit, fallback et unknown compris. Avec forceToGenderize, elle coûte 1 crédit si le jeu de données résout la requête, ou 2 au total si l’IA est utilisée. La facturation des erreurs est indiquée séparément dans meta.usage.
Le domaine de l’adresse est-il supprimé avant l’envoi à l’IA ?
Cette suppression n’est pas garantie. Les candidats du jeu de données proviennent de la partie avant @, tandis que l’IA reçoit la valeur envoyée avec la consigne d’ignorer le domaine et le suffixe commençant par +. Utilisez le mode jeu de données seul si votre processus l’exige.