Documentation d'API
Namsor a développé une technologie de vérification des noms, capable de créer une analyse complète grâce à un traitement multiple. Notre API peut classer les noms par origine, par ethnicité, par diaspora, par pays de résidence, par sexe, et prend en charge de nombreuses écritures*.
Introduction
À propos
- L'URL du point de terminaison est: https://v2.namsor.com/NamSorAPIv2
- Tous les points de terminaison nécessitent une clé d'API.
- Ne partagez JAMAIS votre clé d'API.
Requêtes et réponses d'API
- Tous les points de terminaison renvoient un JSON contenant soit un objet, soit un tableau d'objets imbriqué.
- Actuellement, certains points de terminaison de l'API NamSor utilisent des structures d'objets imbriquées dans leur corps de requête et/ou leurs réponses, veuillez vous référer à l'exemple de code correspondant.
- Sachez que les données dans les exemples de code ont été encodées en URL dans les caractères de code ASCII correspondants si nécessaire, par exemple 谢晓亮 est remplacé par %E8%B0%A2%E6%99%93% E4%BA%AE. Les URL ne peuvent pas contenir d'espaces ni de caractères non ASCII. Lorsque vous envoyez des requêtes GET à l'API, utilisez le codage d'URL pour convertir les caractères non ASCII dans un format pouvant être transmis sur Internet.
Confidentialité des données
Par défaut, l'algorithme d'apprentissage automatique de Namsor peut améliorer l'évaluation des données en fonction des entrées de données et stocke les journaux des demandes soumises. Vous pouvez modifier ces paramètres soit dans votre compte utilisateur, soit en appelant les points de terminaison API dédiés. Tous les journaux de données sont sécurisés à l'aide du cryptage AES avant d'être stockés.
Si vous souhaitez désactiver l'apprentissage automatique en fonction de vos soumissions, veuillez définir learnable sur false dans la section "Protection de la vie privée" à la page Mon compte. Lorsqu'il est défini sur false pour une clé API, les données traitées à l'aide de cette clé n'alimenteront pas l'algorithme d'apprentissage automatique.
Si vous souhaitez désactiver l'historique d'utilisation du service, veuillez définir anonymized sur true dans la section "Protection de la vie privée" à la page Mon compte. Lorsqu'il est défini sur true pour une clé API, les données traitées à l'aide de cette clé seront anonymisées de manière irréversible à l'aide du cryptage SHA. Notez que le traitement intelligent des requêtes redondantes fonctionnera toujours même si vos données sont anonymisées.
Authentication
Création de clé d'API
Les comptes clients sont communs à tous les sites du groupe Namsor. Pour créer une clé API, visitez Namsor ou un autre site du groupe Namsor et créer un compte. Accédez à la page d'informations sur le compte pour récupérer votre clé API. Votre compte nouvellement créé est livré avec 500 crédits gratuits que vous pouvez utiliser immédiatement avec l'un des outils de Namsor : API, processeur de fichiers CSV et Excel ou outils de développement.
Installation clé d'API
Votre clé API doit être définie dans l'en-tête de votre requête à l'aide de la propriété X-API-KEY. Veuillez vous référer aux exemples de code fournis pour une installation correcte de la clé.
Vous devez remplacer your-api-key par votre clé API Namsor.
Crédits
Que sont les crédits
Nous utilisons un système de crédit pour suivre l'utilisation de nos services. Chaque plan est livré avec une quantité mensuelle de crédits données et un prix correspondant. Le plan d'abonnement gratuit de base vous accorde 500 crédits mais d'autres plans sont disponibles au cas où vous auriez des exigences plus élevées. À titre d'exemple, avec 500 crédits vous pouvez soit :
- Traiter 50 noms pour déterminer leurs origines.
- Traiter 25 noms pour déterminer leurs diasporas.
- Transliterer 500 noms Japonais.
- Traitez 50 noms pour déterminer leur pays de résidence.
- Traitez 500 noms pour déterminer leur sexe.
Les routes d'administration sont gratuites.
Tolérance des opérations répétées
Notre API propose un traitement intelligent et ne facturera pas l'analyse de données identiques (jusqu'à 20 fois). Par exemple, si vous soumettez le même nom complet 5 fois afin de déduire son origine, vous ne serez facturé que 1 crédit.
Limite flexible vs limite stricte
Dans votre compte utilisateur, vous pouvez définir deux types de limites d'utilisation du crédit :
- Une limite souple qui déclenchera une notification par e-mail lorsqu'elle sera atteinte.
- Une limite stricte qui déclenchera une notification par e-mail et bloquera la clé API lorsqu'elle sera atteinte.
Suivre l'utilisation
Il existe deux façons de suivre l'utilisation de votre crédit : vérifiez les graphiques fournis dans votre compte utilisateur ou interrogez les itinéraires d'administration appropriés (utilisation de l'API, historique de l'utilisation de l'API et agrégat de l'historique de l'utilisation de l'API).
Erreurs
- 401Non autoriséClé API manquante ou incorrecte.
- 403InterditLimite API atteinte ou clé API désactivée.
- 404IntrouvableL'itinéraire spécifié est introuvable.
- 500Erreur de serveur interneErreur de serveur. Réessayez plus tard.
Origine des noms
Namsor vous aide à trouver des informations détaillées sur l'origine d'un nom en établissant le pays d'origine d'un nom, l'ethnie, la diaspora et le pays de residence. Nous fournissons également une API d'évaluation des corridors, pour vérifier les informations générales sur les interactions internationales.
Origine
La fonctionnalité Origine analyse un prénom et/ou un nom de famille pour identifier le pays d'origine. L'ajout d'un prénom et d'un nom augmente la précision de l'estimation.
La fonctionnalité renvoie la région d'origine, le pays d'origine et une liste des 10 pays d'origine les plus probables. Chaque pays d'origine estimé est accompagné d'une probabilité calibrée.
Notez que le fonctionnalité Diaspora peut être mieux adaptée aux pays multiculturels, tels que les États-Unis, le Canada, l'Australie, la Nouvelle-Zélande et d'autres "melting-pots".
- Description : Renvoie le pays d'origine le plus probable d'un maximum de 100 prénoms et/ou noms de famille.
- Coût : 10 crédits par nom.
- Tester : Fonctionnalité Origine.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/originBatchEn-tête de requête
| Propriété | Valeurs | Requis | Description |
|---|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor | |
| X-OPTION-RELIGION-STATS | True | Optionel | Retourne les statistiques religieuses pour les pays d'origine, les pays de residence et les diasporas estimés. Par défault la fonctionnalité est désactivée. Ajoutez au Header de la requête la paramêtre X-OPTION-RELIGION-STATS sur True pour l'activer. |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | A list of personal names. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Optionel | Prénom. |
| [{...}].lastName | String | Optionel | Nom de famille. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms renseignés avec leurs pays d'origine. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].countryOrigin | String | Pays d'origine le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| [{...}].countryOriginAlt | String | Second pays d'origine le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| [{...}].countriesOriginTop | Array | Top 10 des pays d'origine les plus probables, au format ISO 3166-1 alpha-2, triés du plus probable au moins probable. | Pays d'origine |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].regionOrigin | String | Région d'origine la plus probable. | Régions |
| [{...}].topRegionOrigin | String | Région d'origine la plus probable (classification alternative). | Régions |
| [{...}].subRegionOrigin | String | Sous-région d'origine la plus probable. | Sous régions |
| [{...}].probabilityCalibrated | Number | La probabilité calibrée que 'countryOrigin' ait été deviné correctement. -1 = toujours en cours de calibrage. | |
| [{...}].probabilityAltCalibrated | Number | La probabilité calibrée que 'countryOrigin' ou 'countryOriginAlt' aient été deviné correctement. -1 = toujours en cours de calibrage. | |
| Optionnel : X-OPTION-RELIGION-STATS = True | |||
| [{...}].religionStats | Array of objects | Statistiques religieuses pour le pays d'origine le plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion dans le pays d'origine le plus probable (countryOrigin). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion dans le pays d'origine le plus probable (countryOrigin). | |
| [{...}].religionStatsAlt | Array of objects | Statistiques religieuses pour le second pays d'origine le plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion dans le second pays d'origine le plus probable (countryOriginAlt). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion dans le second pays d'origine le plus probable (countryOriginAlt). |
Name Origin exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/originBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"e630dda5-13b3-42c5-8f1d-648aa8a21c42","firstName":"Keith","lastName":"Haring"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstName": "Keith",
"lastName": "Haring"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstName": "Keith",
"lastName": "Haring",
"countryOrigin": "GB",
"countryOriginAlt": "IE",
"countriesOriginTop": ["GB", "IE", "DE", "NL", "DK", "MY", "SE", "CH", "NO", "EE"],
"score": 3.736975858512923,
"regionOrigin": "Europe",
"topRegionOrigin": "Europe",
"subRegionOrigin": "Northern Europe",
"probabilityCalibrated": 0.48126571888420216,
"probabilityAltCalibrated": 0.622489299549084,
"religionStats": [
{
"religion": "Christian",
"pct": 85.24262131
},
{
"religion": "Unaffiliated",
"pct": 14.20710355
},
{
"religion": "Other",
"pct": 0.300150075
},
{
"religion": "Buddhist",
"pct": 0.050025013
},
{
"religion": "Folk",
"pct": 0.050025013
},
{
"religion": "Hindu",
"pct": 0.050025013
},
{
"religion": "Jewish",
"pct": 0.050025013
},
{
"religion": "Muslim",
"pct": 0.050025013
}
],
"religionStatsAlt": [
{
"religion": "Christian",
"pct": 88.97427291753932
},
{
"religion": "Unaffiliated",
"pct": 9.78531187532157
},
{
"religion": "Muslim",
"pct": 0.6298564872835054
},
{
"religion": "Other",
"pct": 0.16200879680269425
},
{
"religion": "Buddhist",
"pct": 0.13284624102403442
},
{
"religion": "Folk",
"pct": 0.13284624102403442
},
{
"religion": "Hindu",
"pct": 0.13284624102403442
},
{
"religion": "Jewish",
"pct": 0.050011199980789234
}
]
}
]
}Valeurs retournées uniquement si l'option de statistiques religieuses est activée X-OPTION-RELIGION-STATS : True.
{
religionStats: [
{ religion: 'Christian', pct: 85.24262131 },
{ religion: 'Unaffiliated', pct: 14.20710355 },
{ religion: 'Other', pct: 0.300150075 },
{ religion: 'Buddhist', pct: 0.050025013 },
{ religion: 'Folk', pct: 0.050025013 },
{ religion: 'Hindu', pct: 0.050025013 },
{ religion: 'Jewish', pct: 0.050025013 },
{ religion: 'Muslim', pct: 0.050025013 },
],
religionStatsAlt: [
{ religion: 'Christian', pct: 88.97427291753932 },
{ religion: 'Unaffiliated', pct: 9.78531187532157 },
{ religion: 'Muslim', pct: 0.6298564872835054 },
{ religion: 'Other', pct: 0.16200879680269425 },
{ religion: 'Buddhist', pct: 0.13284624102403442 },
{ religion: 'Folk', pct: 0.13284624102403442 },
{ religion: 'Hindu', pct: 0.13284624102403442 },
{ religion: 'Jewish', pct: 0.050011199980789234 },
],
}Diaspora
La fonctionnalité Diaspora analyse un nom pour identifier l'ethnie/diaspora la plus probable. L'ajout d'un prénom, d'un nom de famille et d'un pays de résidence augmente la précision de la diaspora estimée.
La fonctionnalité renvoie l'ethnie/diaspora la plus probable et un top 10 des ethnies classées du plus probable au moins probable. Chaque ethnie renvoyée est accompagnée d'une probabilité calibrée.
- Description : Estime les ethnicités/diasporas les plus vraisemblable d'un ensemble de prénoms, d'un noms de famille et de pays de résidence.
- Coût : 20 crédits par nom.
- Tester : Fonctionnalité Diaspora.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/diasporaBatchEn-tête de requête
| Propriété | Valeurs | Requis | Description |
|---|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor | |
| X-OPTION-RELIGION-STATS | True | Optionel | Retourne les statistiques religieuses pour les pays d'origine, les pays de residence et les diasporas estimés. Par défault la fonctionnalité est désactivée. Ajoutez au Header de la requête la paramêtre X-OPTION-RELIGION-STATS sur True pour l'activer. |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms personnels avec leur pays de résidence. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Optionel | Prénom. |
| [{...}].lastName | String | Requis | Nom de famille. |
| [{...}].countryIso2 | String | Optionel | Pays de résidence, au format ISO 3166-1 alpha-2. "US" par défault (si aucune valeur indiquée). |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms soumis avec leurs ethnies estimées. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].ethnicityAlt | String | Seconde ethnie la plus probable. | Ethnicités et diasporas |
| [{...}].ethnicity | String | Ethnie la plus probable. | Ethnicités et diasporas |
| [{...}].lifted | Boolean | Indique si l'origine ethnique de la sortie est basée uniquement sur l'apprentissage automatique, ou si elle est davantage considérée comme un fait connu par une règle spécifique au pays. | |
| [{...}].countryIso2 | String | Submitted Pays de résidence, au format ISO 3166-1 alpha-2. | Pays de résidence |
| [{...}].ethnicitiesTop | Array | Top 10 des ethnies les plus vraisemblables, classées du plus probable au moins probable. | Ethnicités et diasporas |
| [{...}].probabilityCalibrated | Number | La probabilité calibrée que 'ethnicity' ait été devinée correctement. -1 = toujours en cours de calibrage. | |
| [{...}].probabilityAltCalibrated | Number | La probabilité calibrée que 'ethnicity' ou 'ethnicityAlt' aient été devinée correctement. -1 = toujours en cours de calibrage. | |
| Optionnel : X-OPTION-RELIGION-STATS = True | |||
| [{...}].religionStats | Array of objects | Statistiques religieuses pour la diaspora la plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion au sein de la diaspora la plus probable (ethnicity). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion au sein de la diaspora la plus probable (ethnicity). | |
| [{...}].religionStatsAlt | Array of objects | Statistiques religieuses pour la seconde diaspora la plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion au sein de la seconde diaspora la plus probable (ethnicityAlt). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion au sein de la seconde diaspora la plus probable (ethnicityAlt). |
Name Diaspora exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/diasporaBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"0d7d6417-0bbb-4205-951d-b3473f605b56","firstName":"Keith","lastName":"Haring","countryIso2":"US"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "0d7d6417-0bbb-4205-951d-b3473f605b56",
"firstName": "Keith",
"lastName": "Haring",
"countryIso2": "US"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "0d7d6417-0bbb-4205-951d-b3473f605b56",
"firstName": "Keith",
"lastName": "Haring",
"score": 10.578504679244919,
"ethnicityAlt": "British",
"ethnicity": "German",
"lifted": false,
"countryIso2": "US",
"ethnicitiesTop": ["German", "British", "Dutch", "Danish", "Irish", "Jewish", "Norwegian", "HispanoLatino", "Swedish", "AfricanAmerican"],
"probabilityCalibrated": 0.6115763692637636,
"probabilityAltCalibrated": 0.6115763692637636,
"religionStats": [
{
"religion": "Christian",
"pct": 68.7
},
{
"religion": "Unaffiliated",
"pct": 24.7
},
{
"religion": "Muslim",
"pct": 5.8
},
{
"religion": "Buddhist",
"pct": 0.3
},
{
"religion": "Jewish",
"pct": 0.3
},
{
"religion": "Other",
"pct": 0.1
},
{
"religion": "Folk",
"pct": 0.05
},
{
"religion": "Hindu",
"pct": 0.05
}
],
"religionStatsAlt": [
{
"religion": "Christian",
"pct": 68.7
},
{
"religion": "Unaffiliated",
"pct": 24.7
},
{
"religion": "Muslim",
"pct": 5.8
},
{
"religion": "Buddhist",
"pct": 0.3
},
{
"religion": "Jewish",
"pct": 0.3
},
{
"religion": "Other",
"pct": 0.1
},
{
"religion": "Folk",
"pct": 0.05
},
{
"religion": "Hindu",
"pct": 0.05
}
]
}
]
}Valeurs retournées uniquement si l'option de statistiques religieuses est activée X-OPTION-RELIGION-STATS : True.
{
religionStats: [
{ religion: 'Christian', pct: 68.7 },
{ religion: 'Unaffiliated', pct: 24.7 },
{ religion: 'Muslim', pct: 5.8 },
{ religion: 'Buddhist', pct: 0.3 },
{ religion: 'Jewish', pct: 0.3 },
{ religion: 'Other', pct: 0.1 },
{ religion: 'Folk', pct: 0.05 },
{ religion: 'Hindu', pct: 0.05 },
],
religionStatsAlt: [
{ religion: 'Christian', pct: 68.7 },
{ religion: 'Unaffiliated', pct: 24.7 },
{ religion: 'Muslim', pct: 5.8 },
{ religion: 'Buddhist', pct: 0.3 },
{ religion: 'Jewish', pct: 0.3 },
{ religion: 'Other', pct: 0.1 },
{ religion: 'Folk', pct: 0.05 },
{ religion: 'Hindu', pct: 0.05 },
],
}Ethnie US
La fonctionnalité Ethnie US analyse un nom pour identifier l'ethnie 'raciale' US la plus probable. L'ajout d'un prénom, d'un nom de famille et d'un pays de résidence augmente la précision de l'ethnie 'raciale' américaine déterminée.
La fonction renvoie l'ethnie 'raciale' US la plus probable et une liste des ethnies 'raciales' US triées du plus probable au moins probable. Chaque ethnie 'raciale' estimée est accompagnée d'une probabilité calibrée.
L'ethnie 'raciale' US est une catégorisation officielle du bureau du recensement des États-Unis
- Description : Estime l'ethnie 'raciale' US jusqu'à 100 prénoms et/ou noms de famille.
- Precision :
- Coût : 10 crédits par nom.
- Tester : Fonctionnalité Ethnie US.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/usRaceEthnicityBatchEn-tête de requête
| Propriété | Valeurs | Requis | Description |
|---|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor | |
| X-OPTION-USRACEETHNICITY-TAXONOMY | USRACEETHNICITY-6CLASSES | Optionel | Recenseurs pour l'ethnie 'raciale' estimée. Ne précisez pas la propriété de la requête http pour obtenir 4 classes (W_NL, HL, A, B_NL), USRACEETHNICITY-6CLASSES renverra 6 classes (W_NL, HL, A, B_NL, AI_AN, PI). Pour les noms internationaux (non-résidents américains), veuillez choisir 4 classes. |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms personnels avec leur pays de résidence. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Optionel | Prénom. |
| [{...}].lastName | String | Optionel | Nom de famille. |
| [{...}].countryIso2 | String | Optionel | Pays de résidence, au format ISO 3166-1 alpha-2. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms renseignés enrichis de leur ethnie 'raciale'. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].raceEthnicityAlt | String | Seconde ethnie 'raciale' la plus probable (catégorisation 'raciale' US de l'US Census). | Ethnies raciales US |
| [{...}].raceEthnicity | String | Ethnie 'raciale' la plus probable (catégorisation 'raciale' US de l'US Census). | Ethnies raciales US |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].raceEthnicitiesTop | Array | Ethnies 'raciales' triées des plus probables au moins probables. | Ethnies raciales US |
| [{...}].probabilityCalibrated | Number | La probabilité calibrée que 'raceEthnicity' ait été devinée correctement. -1 = toujours en cours de calibrage. | |
| [{...}].probabilityAltCalibrated | Number | La probabilité calibrée que 'raceEthnicity' ou 'raceEthnicityAlt' aient été devinée correctement. -1 = toujours en cours de calibrage. |
Name US Race exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/usRaceEthnicityBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"85dd5f48-b9e1-4019-88ce-ccc7e56b763f","firstName":"Keith","lastName":"Haring","countryIso2":"US"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "85dd5f48-b9e1-4019-88ce-ccc7e56b763f",
"firstName": "Keith",
"lastName": "Haring",
"countryIso2": "US"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "85dd5f48-b9e1-4019-88ce-ccc7e56b763f",
"firstName": "Keith",
"lastName": "Haring",
"raceEthnicityAlt": "AI_AN",
"raceEthnicity": "W_NL",
"score": 7.104050454229515,
"raceEthnicitiesTop": ["W_NL", "AI_AN", "B_NL", "A", "PI", "HL"],
"probabilityCalibrated": 0.7271969971540807,
"probabilityAltCalibrated": 0.8701551006716921
}
]
}Ethnie US (ZIP)
La fonctionnalité Ethnie US (ZIP) analyse un nom pour identifier l'ethnie 'raciale' US la plus probable avec une précision améliorée par rapport à la fonctionnalité de base Ethnie US. L'ajout d'un prénom, d'un nom de famille et d'un pays de résidence augmente la précision de l'ethnie 'raciale' américaine déterminée.
La fonction renvoie l'ethnie 'raciale' US la plus probable et une liste des ethnies 'raciales' US triées du plus probable au moins probable. Chaque ethnie 'raciale' estimée est accompagnée d'une probabilité calibrée.
L'ethnie 'raciale' US est une catégorisation officielle du bureau du recensement des États-Unis
- Description : Estime l'ethnie 'raciale' US jusqu'à 100 prénoms et/ou noms de famille, avec une précision améliorée grâce à un code postal de résidence.
- Precision :
- Coût : 10 crédits par nom.
- Tester : Fonctionnalité Ethnie US (ZIP).
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/usZipRaceEthnicityBatchEn-tête de requête
| Propriété | Valeurs | Requis | Description |
|---|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor | |
| X-OPTION-USRACEETHNICITY-TAXONOMY | USRACEETHNICITY-6CLASSES | Optionel | Recenseurs pour l'ethnie 'raciale' estimée. Ne précisez pas la propriété de la requête http pour obtenir 4 classes (W_NL, HL, A, B_NL), USRACEETHNICITY-6CLASSES renverra 6 classes (W_NL, HL, A, B_NL, AI_AN, PI). Pour les noms internationaux (non-résidents américains), veuillez choisir 4 classes. |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms de personnes avec leur pays de résidence et leur code postal. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Optionel | Prénom. |
| [{...}].lastName | String | Optionel | Nom de famille. |
| [{...}].countryIso2 | String | Optionel | Pays de résidence, au format ISO 3166-1 alpha-2. |
| [{...}].zipCode | String | Requis | Code postal (5 chiffres) de résidence utilisé par le service postal des États-Unis (USPS). |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms renseignés enrichis de leur ethnie 'raciale'. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].raceEthnicityAlt | String | Seconde ethnie 'raciale' la plus probable (catégorisation 'raciale' US de l'US Census). | Ethnies raciales US |
| [{...}].raceEthnicity | String | Ethnie 'raciale' la plus probable (catégorisation 'raciale' US de l'US Census). | Ethnies raciales US |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].raceEthnicitiesTop | Array | Ethnies 'raciales' triées des plus probables au moins probables. | Ethnies raciales US |
| [{...}].probabilityCalibrated | Number | La probabilité calibrée que 'raceEthnicity' ait été devinée correctement. -1 = toujours en cours de calibrage. | |
| [{...}].probabilityAltCalibrated | Number | La probabilité calibrée que 'raceEthnicity' ou 'raceEthnicityAlt' aient été devinée correctement. -1 = toujours en cours de calibrage. |
Name US Race ZIP exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/usZipRaceEthnicityBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"728767f9-c5b2-4ed3-a071-828077f16552","firstName":"Keith","lastName":"Haring","countryIso2":"US","zipCode":"10019"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "728767f9-c5b2-4ed3-a071-828077f16552",
"firstName": "Keith",
"lastName": "Haring",
"countryIso2": "US",
"zipCode": "10019"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "728767f9-c5b2-4ed3-a071-828077f16552",
"firstName": "Keith",
"lastName": "Haring",
"raceEthnicityAlt": "AI_AN",
"raceEthnicity": "W_NL",
"score": 3.9085123822664136,
"raceEthnicitiesTop": ["W_NL", "AI_AN", "A", "B_NL", "PI", "HL"],
"probabilityCalibrated": 0.6021205204922562,
"probabilityAltCalibrated": 0.8421508050514268
}
]
}Pays de Residence
La fonctionnalité Pays de Residence analyse un nom (prénom, nom de famille ou nom complet) pour identifier son pays de résidence.
La fonctionnalité renvoie la région de résidence, le pays de résidence et une liste des 10 principaux pays de résidence, classés du plus probable au moins probable. Chaque pays de résidence renvoyé est accompagné d'une probabilité calibrée.
- Description : Renvoie le pays de résidence le plus probable parmi 100 prénoms, noms ou noms complets.
- Coût : 10 crédits par nom.
- Tester : Fonctionnalité Pays de Residence.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/countryBatchEn-tête de requête
| Propriété | Valeurs | Requis | Description |
|---|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor | |
| X-OPTION-RELIGION-STATS | True | Optionel | Retourne les statistiques religieuses pour les pays d'origine, les pays de residence et les diasporas estimés. Par défault la fonctionnalité est désactivée. Ajoutez au Header de la requête la paramêtre X-OPTION-RELIGION-STATS sur True pour l'activer. |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | A list of personal names. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].name | String | Requis | Prénom, ou nom de famille, ou nom complet. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms renseignés avec leurs pays de résidence. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].name | String | Nom renseigné. | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].country | String | Pays de résidence le plus probable, au format ISO 3166-1 alpha-2. | Pays de résidence |
| [{...}].countryAlt | String | Second pays de résidence le plsu vraisemblable, au format ISO 3166-1 alpha-2. | Pays de résidence |
| [{...}].region | String | Région de résidence la plus probable. | Régions |
| [{...}].topRegion | String | Région de résidence la plus probable (classification alternative). | Régions |
| [{...}].subRegion | String | Sous-région de résidence la plus probable. | Sous régions |
| [{...}].countriesTop | Array | Top 10 des pays de résidence les plus probables, au format ISO 3166-1 alpha-2, triés du plus probable au moins probable. | |
| [{...}].probabilityCalibrated | Number | La probabilité calibrée que 'country' ait été deviné correctement. -1 = toujours en cours de calibrage. | |
| [{...}].probabilityAltCalibrated | Number | La probabilité calibrée que 'country' ou 'countryAlt' aient été deviné correctement. -1 = toujours en cours de calibrage. | |
| Optionnel : X-OPTION-RELIGION-STATS = True | |||
| [{...}].religionStats | Array of objects | Statistiques religieuses pour le pays de résidence le plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion dans le pays de résidence le plus probable (country). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion dans le pays de résidence le plus probable (country). | |
| [{...}].religionStatsAlt | Array of objects | Statistiques religieuses pour le second pays de résidence le plus probable. Est renvoyé uniquement si l'option de statistiques religieuses est activée (X-OPTION-RELIGION-STATS : True). | |
| [{...}].religion | String | Religion dans le second pays de résidence le plus probable (countryAlt). | Religions |
| [{...}].pct | Number | Pourcentage de la population pratiquant cette religion dans le second pays de résidence le plus probable (countryAlt). |
Name Country exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/countryBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"9a3283bd-4efb-4b7b-906c-e3f3c03ea6a4","name":"Keith Haring"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "9a3283bd-4efb-4b7b-906c-e3f3c03ea6a4",
"name": "Keith Haring"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "9a3283bd-4efb-4b7b-906c-e3f3c03ea6a4",
"name": "Keith Haring",
"score": 14.474855749439138,
"country": "US",
"countryAlt": "NZ",
"region": "Northern America",
"topRegion": "Americas",
"subRegion": "Northern America",
"countriesTop": ["US", "NZ", "AU", "GB", "IE", "CA", "DE", "SG", "JM", "HK"],
"probabilityCalibrated": 0.5543051242619337,
"probabilityAltCalibrated": 0.5722556327291567,
"religionStats": [
{
"religion": "Christian",
"pct": 78.3
},
{
"religion": "Unaffiliated",
"pct": 16.4
},
{
"religion": "Jewish",
"pct": 1.8
},
{
"religion": "Buddhist",
"pct": 1.2
},
{
"religion": "Muslim",
"pct": 0.9
},
{
"religion": "Hindu",
"pct": 0.6
},
{
"religion": "Other",
"pct": 0.6
},
{
"religion": "Folk",
"pct": 0.2
}
],
"religionStatsAlt": [
{
"religion": "Christian",
"pct": 78.3007843079025
},
{
"religion": "Unaffiliated",
"pct": 16.39975226849653
},
{
"religion": "Jewish",
"pct": 1.799802305332493
},
{
"religion": "Buddhist",
"pct": 1.1998700873301702
},
{
"religion": "Muslim",
"pct": 0.8999039783290091
},
{
"religion": "Other",
"pct": 0.5999661259551334
},
{
"religion": "Hindu",
"pct": 0.5999378693278477
},
{
"religion": "Folk",
"pct": 0.1999830573262992
}
]
}
]
}Valeurs retournées uniquement si l'option de statistiques religieuses est activée X-OPTION-RELIGION-STATS : True.
{
religionStats: [
{ religion: 'Christian', pct: 78.3 },
{ religion: 'Unaffiliated', pct: 16.4 },
{ religion: 'Jewish', pct: 1.8 },
{ religion: 'Buddhist', pct: 1.2 },
{ religion: 'Muslim', pct: 0.9 },
{ religion: 'Hindu', pct: 0.6 },
{ religion: 'Other', pct: 0.6 },
{ religion: 'Folk', pct: 0.2 },
],
religionStatsAlt: [
{ religion: 'Christian', pct: 78.3007843079025 },
{ religion: 'Unaffiliated', pct: 16.39975226849653 },
{ religion: 'Jewish', pct: 1.799802305332493 },
{ religion: 'Buddhist', pct: 1.1998700873301702 },
{ religion: 'Muslim', pct: 0.8999039783290091 },
{ religion: 'Other', pct: 0.5999661259551334 },
{ religion: 'Hindu', pct: 0.5999378693278477 },
{ religion: 'Folk', pct: 0.1999830573262992 },
],
}Corridor
La fonctionnalité Corridor analyse le prénom, le nom et le pays de résidence de deux personnes pour générer un rapport complet de l'interaction.
- Description : Renvoie une analyse complète d'un ensemble d'interactions transfrontalières (jusqu'à 100) entre deux noms en utilisant leur contexte géographique. L'expéditeur est celui qui a initié l'interaction (from), tandis que le destinataire est celui destiné à recevoir l'interaction (to).
- Coût : 20 crédits par nom.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/corridorBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre cl é d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "corridorFromTo" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| corridorFromTo | Array of objects | Requis | A list of name pairs, with country code (nameFrom -> nameTo).. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstLastNameGeoFrom | Object | Requis | . |
| {...}.id | String | Optionel | Identifiant unique. |
| {...}.firstName | String | Requis | Prénom de l'expéditeur. |
| {...}.lastName | String | Requis | Nom de famille de l'expéditeur. |
| {...}.countryIso2 | String | Requis | Pays d'origine de l'expéditeur, au format ISO 3166-1 alpha-2. |
| [{...}].firstLastNameGeoTo | Object | Requis | . |
| {...}.id | String | Optionel | Identifiant unique. |
| {...}.firstName | String | Requis | Prénom du destinataire. |
| {...}.lastName | String | Requis | Nom de famille du destinataire. |
| {...}.countryIso2 | String | Requis | Pays d'origine du destinataire, au format ISO 3166-1 alpha-2. |
Réponse
Le corps de la réponse HTTP est un tableau "corridorFromTo" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| corridorFromTo | Array of objects | A list of classified name pairs.. | |
| [{...}].id | String | Identifiant unique. | |
| [{...}].firstLastNameGeoFromGender | Object | Données de genre pour l'expéditeur.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom de l'expéditeur renseigné. | |
| {...}.lastName | String | Nom de famille de l'expéditeur renseigné. | |
| {...}.likelyGender | String | Genre le plus probable de l'expéditeur. | Genres |
| {...}.genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. | |
| [{...}].firstLastNameGeoToGender | Object | Données de genre pour le destinataire.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom du destinataire renseigné. | |
| {...}.lastName | String | Nom de famille du destinataire renseigné. | |
| {...}.likelyGender | String | Genre le plus probable du destinataire. | Genres |
| {...}.genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. | |
| [{...}].firstLastNameGeoFromOrigin | Object | Données d'origine pour l'expéditeur.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom de l'expéditeur renseigné. | |
| {...}.lastName | String | Nom de famille de l'expéditeur renseigné. | |
| {...}.countryOrigin | String | Pays d'origine de l'expéditeur le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| {...}.countryOriginAlt | String | Second pays d'origine de l'expéditeur le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| {...}.countriesOriginTop | Array | Top 10 des pays d'origine de l'expéditeur les plus probables, au format ISO 3166-1 alpha-2, triés du plus probable au moins probable. | Pays d'origine |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.regionOrigin | String | Région d'origine de l'expéditeur la plus probable. | Régions |
| {...}.topRegionOrigin | String | Région d'origine de l'expéditeur la plus probable (classification alternative). | Régions |
| {...}.subRegionOrigin | String | Sous-région d'origine de l'expéditeur la plus probable. | Sous régions |
| {...}.probabilityCalibrated | Number | La probabilité calibrée pour 'countryOrigin' d'avoir été devinée correctement. -1 = toujours en cours de calibrage. | |
| {...}.probabilityAltCalibrated | Number | La probabilité calibrée pour 'countryOrigin' ou 'countryOriginAlt' d'avoir été devinée correctement. -1 = toujours en cours de calibrage. | |
| [{...}].firstLastNameGeoToOrigin | Object | Données d'origine pour le destinataire.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom du destinataire renseigné. | |
| {...}.lastName | String | Nom de famille du destinataire renseigné. | |
| {...}.countryOrigin | String | Pays d'origine du destinataire le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| {...}.countryOriginAlt | String | Second pays d'origine du destinataire le plus probable, au format ISO 3166-1 alpha-2. | Pays d'origine |
| {...}.countriesOriginTop | Array | Top 10 des pays d'origine du destinataire les plus probables, au format ISO 3166-1 alpha-2, triés du plus probable au moins probable. | Pays d'origine |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.regionOrigin | String | Région d'origine du destinataire la plus probable. | Régions |
| {...}.topRegionOrigin | String | Région d'origine du destinataire la plus probable (classification alternative). | Régions |
| {...}.subRegionOrigin | String | Sous-région d'origine du destinataire la plus probable. | Sous régions |
| {...}.probabilityCalibrated | Number | La probabilité calibrée pour 'countryOrigin' d'avoir été devinée correctement. -1 = toujours en cours de calibrage. | |
| {...}.probabilityAltCalibrated | Number | La probabilité calibrée pour 'countryOrigin' ou 'countryOriginAlt' d'avoir été devinée correctement. -1 = toujours en cours de calibrage. | |
| [{...}].firstLastNameGeoFromDiaspora | Object | Données de la diaspora pour l'expéditeur.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom de l'expéditeur renseigné. | |
| {...}.lastName | String | Nom de famille de l'expéditeur renseigné. | |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.ethnicityAlt | String | Seconde ethnie de l'expéditeur la plus probable. | Ethnicités et diasporas |
| {...}.ethnicity | String | Ethnie de l'expéditeur la plus probable. | Ethnicités et diasporas |
| {...}.lifted | Boolean | Indique si l'origine ethnique de la sortie est basée uniquement sur l'apprentissage automatique, ou si elle est davantage considérée comme un fait connu par une règle spécifique au pays. | |
| {...}.countryIso2 | String | Pays d'origine de l'expéditeur renseigné, au format ISO 3166-1 alpha-2. | Pays de résidence |
| {...}.ethnicitiesTop | Array | Top 10 des ethnies de l'expéditeur les plus vraisemblables, classées du plus probable au moins probable. | Ethnicités et diasporas |
| [{...}].firstLastNameGeoToDiaspora | Object | Données de la diaspora pour le destinataire.. | |
| {...}.script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| {...}.id | String | Identifiant unique. | |
| {...}.firstName | String | Prénom du destinataire renseigné. | |
| {...}.lastName | String | Nom de famille du destinataire renseigné. | |
| {...}.score | Number | Plus élevé implique un résultat plus fiable, mais le score n'est pas normalisé. Utiliser la probabilité Calibrée si disponible. | |
| {...}.ethnicityAlt | String | Seconde ethnie du destinataire la plus probable. | Ethnicités et diasporas |
| {...}.ethnicity | String | Ethnie du destinataire la plus probable. | Ethnicités et diasporas |
| {...}.lifted | Boolean | Indique si l'origine ethnique de la sortie est basée uniquement sur l'apprentissage automatique, ou si elle est davantage considérée comme un fait connu par une règle spécifique au pays. | |
| {...}.countryIso2 | String | Pays d'origine du destinataire renseigné, au format ISO 3166-1 alpha-2. | Pays de résidence |
| {...}.ethnicitiesTop | Array | Top 10 des ethnies du destinataire les plus vraisemblables, classées du plus probable au moins probable. | Ethnicités et diasporas |
Names Corridor exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/corridorBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"corridorFromTo":[{"id":"e630dda5-13b3-42c5-8f1d-648aa8a21c42","firstLastNameGeoFrom":{"id":"e630dda5-13b3-42c5-8f1d-648aa8a21c42","firstName":"Ada","lastName":"Lovelace","countryIso2":"GB"},"firstLastNameGeoTo":{"id":"e630dda5-13b3-42c5-8f1d-648aa8a21c42","firstName":"Nicolas","lastName":"Tesla","countryIso2":"US"}}]}'Paramètre du corps :
{
"corridorFromTo": [
{
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstLastNameGeoFrom": {
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstName": "Ada",
"lastName": "Lovelace",
"countryIso2": "GB"
},
"firstLastNameGeoTo": {
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstName": "Nicolas",
"lastName": "Tesla",
"countryIso2": "US"
}
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"corridorFromTo": [
{
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"firstLastNameGeoFromGender": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c43",
"firstName": "Ada",
"lastName": "Lovelace",
"likelyGender": "female",
"genderScale": 0.9667738179638148,
"score": 20.98847600479561,
"probabilityCalibrated": 0.9833869089819074
},
"firstLastNameGeoToGender": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c41",
"firstName": "Nicolas",
"lastName": "Tesla",
"likelyGender": "male",
"genderScale": -0.9915797101926913,
"score": 30.224379416275056,
"probabilityCalibrated": 0.9957898550963457
},
"firstLastNameGeoFromOrigin": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c43",
"firstName": "Ada",
"lastName": "Lovelace",
"countryOrigin": "IE",
"countryOriginAlt": "GB",
"countriesOriginTop": ["IE", "GB"],
"score": 2.568304424015469,
"regionOrigin": "Europe",
"topRegionOrigin": "Europe",
"subRegionOrigin": "Northern Europe",
"probabilityCalibrated": 0.45562779224760414,
"probabilityAltCalibrated": 0.6327518248452595
},
"firstLastNameGeoToOrigin": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c41",
"firstName": "Nicolas",
"lastName": "Tesla",
"countryOrigin": "FR",
"countryOriginAlt": "GR",
"countriesOriginTop": ["FR", "GR"],
"score": 1.454789764445522,
"regionOrigin": "Europe",
"topRegionOrigin": "Europe",
"subRegionOrigin": "Western Europe",
"probabilityCalibrated": 0.44774495967210787,
"probabilityAltCalibrated": 0.4771001024099368
},
"firstLastNameGeoFromDiaspora": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c43",
"firstName": "Ada",
"lastName": "Lovelace",
"score": 32.41686703300403,
"ethnicityAlt": "TrinidadTobago",
"ethnicity": "British",
"lifted": false,
"countryIso2": "GB",
"ethnicitiesTop": ["British", "TrinidadTobago"]
},
"firstLastNameGeoToDiaspora": {
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c41",
"firstName": "Nicolas",
"lastName": "Tesla",
"score": 1.1421954239282939,
"ethnicityAlt": "Jewish",
"ethnicity": "Italian",
"lifted": false,
"countryIso2": "US",
"ethnicitiesTop": ["Italian", "Jewish"]
}
}
]
}Genre depuis un nom
L'API de vérification de nom de Namsor peut vous aider à déterminer la probabilité qu'une personne soit un homme ou une femme en fonction de son prénom. Nous proposons de nombreuses options de traitement pour la détermination du genre, le nom peut être fourni : sous la forme d'un nom complet, sous la forme d'un prénom et d'un nom . En plus du nom, vous pouvez spécifier le pays d'origine pour améliorer la précision. Notre API prend également en charge les noms chinois, les noms japonais et un grand nombre d'alphabets supplémentaires*.
Genre
La fonctionnalité Genre analyse un prénom et un nom de famille (facultatif) pour identifier le genre le plus probable avec une précision légèrement améliorée par rapport à la fonctionnalité Genre Nom Complet. L'ajout d'un prénom et d'un nom augmente la précision du genre déterminé.
La fonctionnalité renvoie le genre le plus probable accompagné d'une probabilité calibrée. Si la probabilité estimée est comprise entre 45 % et 55 %, le nom peut être interprété comme un nom unisexe.
- Description : Renvoie le genre le plus probable d'un maximum de 100 prénoms et noms (facultatif).
- Precision :
- Coût : 1 crédit par nom.
- Tester : Fonctionnalité Genre.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/genderBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | A list of personal names. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Requis | Prénom. |
| [{...}].lastName | String | Optionel | Nom de famille. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms soumis genrés. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].likelyGender | String | Genre le plus probable. | Genres |
| [{...}].genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. |
Genderize Name exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/genderBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"b590b04c-da23-4f2f-a334-aee384ee420a","firstName":"Keith","lastName":"Haring"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "b590b04c-da23-4f2f-a334-aee384ee420a",
"firstName": "Keith",
"lastName": "Haring"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "b590b04c-da23-4f2f-a334-aee384ee420a",
"firstName": "Keith",
"lastName": "Haring",
"likelyGender": "male",
"genderScale": -0.8126510374561324,
"score": 12.516892456249645,
"probabilityCalibrated": 0.9063255187280662
}
]
}Genre (Geo)
La fonctionnalité Genre (Geo) analyse un prénom, un nom de famille (facultatif) et un pays de résidence pour identifier le genre le plus probable avec une précision améliorée par rapport à la fonctionnalité Genre. L'ajout d'un prénom et d'un nom de famille augmente la précision du genre estimé.
La fonctionnalité renvoie le genre le plus probable accompagné d'une probabilité. Si la probabilité estimée est comprise entre 45 % et 55 %, le nom peut être interprété comme un nom unisexe.
- Description : Renvoie le genre le plus vraisemblable d'un maximum de 100 prénoms et noms de famille (facultatif) en utilisant leur contexte géographique.
- Precision :
- Coût : 1 crédit par nom.
- Tester : Fonctionnalité Genre (Geo).
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/genderGeoBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms personnels avec leur pays de résidence. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].firstName | String | Requis | Prénom. |
| [{...}].lastName | String | Optionel | Nom de famille. |
| [{...}].countryIso2 | String | Requis | Pays de résidence, au format ISO 3166-1 alpha-2. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms soumis genrés. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].firstName | String | Prénom renseigné. | |
| [{...}].lastName | String | Nom de famille renseigné. | |
| [{...}].likelyGender | String | Genre le plus probable. | Genres |
| [{...}].genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. |
Genderize Name Geo exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/genderGeoBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"27fb45db-eddf-40d0-95c1-de9978a166b0","firstName":"Keith","lastName":"Haring","countryIso2":"US"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "27fb45db-eddf-40d0-95c1-de9978a166b0",
"firstName": "Keith",
"lastName": "Haring",
"countryIso2": "US"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "27fb45db-eddf-40d0-95c1-de9978a166b0",
"firstName": "Keith",
"lastName": "Haring",
"likelyGender": "male",
"genderScale": -0.8889514731555574,
"score": 16.03594419932244,
"probabilityCalibrated": 0.9444757365777787
}
]
}Genre Nom Complet
La fonctionnalité Genre Nom Complet analyse un nom complet non divisé (prénom et nom de famille) pour identifier le genre le plus probable.
La fonctionnalité renvoie le genre le plus probable accompagné d'une probabilité calibrée. Si la probabilité estimée est comprise entre 45 % et 55 %, le nom peut être interprété comme un nom non-genré.
Si le nom et le prénom sont clairement identifiables, la fonction Genre sera légèrement plus précise.
- Description : Renvoie le genre le plus probable d'un maximum de 100 noms complets non divisés.
- Precision :
- Coût : 1 crédit par nom.
- Tester : Fonctionnalité Genre Nom Complet.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/genderFullBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms personnels complets. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].name | String | Requis | Nom complet non divisé (prénom et nom de famille). |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms complets soumis genrés. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].name | String | Nom complet renseigné. | |
| [{...}].likelyGender | String | Genre le plus probable. | Genres |
| [{...}].genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. |
Genderize Full Name exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/genderFullBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"0f472330-11a9-49ad-a0f5-bcac90a3f6bf","name":"Keith Haring"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "0f472330-11a9-49ad-a0f5-bcac90a3f6bf",
"name": "Keith Haring"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "0f472330-11a9-49ad-a0f5-bcac90a3f6bf",
"name": "Keith Haring",
"likelyGender": "male",
"genderScale": -0.8744219712791637,
"score": 11.2727995452283,
"probabilityCalibrated": 0.9372109856395818
}
]
}Genre Nom Complet (Geo)
La fonctionnalité Genre Nom Complet (Geo) analyse un nom complet non divisé (prénom et nom de famille) accompagné d'un pays de résidence, afin d'identifier le genre le plus probable avec une meilleure précision que la fonctionnalité de base Genre Nom Complet. La fonctionnalité renvoie le genre le plus probable accompagné d'une probabilité calibrée. Si la probabilité renvoyée est comprise entre 45 % et 55 %, le nom peut être interprété comme un nom non-genré.
Si le nom et le prénom sont clairement identifiables, la fonction Genre Nom Geo sera légèrement plus précise.
- Description : Renvoie le genre le plus probable d'un maximum de 100 noms complets non divisés, en se basant sur un contexte géographique.
- Precision :
- Coût : 1 crédit par nom.
- Tester : Fonctionnalité Genre Nom Complet (Geo).
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/genderFullGeoBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| personalNames | Array of objects | Requis | Une liste de noms complets personnels avec leur pays de résidence. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].name | String | Requis | Nom complet non divisé (prénom et nom de famille). |
| [{...}].countryIso2 | String | Requis | Pays de résidence, au format ISO 3166-1 alpha-2. |
Réponse
Le corps de la réponse HTTP est un tableau "personalNames" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| personalNames | Array of objects | Liste des noms complets soumis genrés. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].name | String | Nom complet renseigné. | |
| [{...}].likelyGender | String | Genre le plus probable. | Genres |
| [{...}].genderScale | Number | Échelle de genre allant de -1 (masculin) à +1 (féminin). | |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. | |
| [{...}].probabilityCalibrated | Number | Plus élevé implique un résultat plus fiable, allant de 0 à 1. |
Genderize Full Name Geo exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/genderFullGeoBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"personalNames":[{"id":"3a2d203a-a6a4-42f9-acd1-1b5c56c7d39f","name":"Keith Haring","countryIso2":"US"}]}'Paramètre du corps :
{
"personalNames": [
{
"id": "3a2d203a-a6a4-42f9-acd1-1b5c56c7d39f",
"name": "Keith Haring",
"countryIso2": "US"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"personalNames": [
{
"script": "LATIN",
"id": "3a2d203a-a6a4-42f9-acd1-1b5c56c7d39f",
"name": "Keith Haring",
"likelyGender": "male",
"genderScale": -0.8716298606148474,
"score": 11.225679376737641,
"probabilityCalibrated": 0.9358149303074237
}
]
}Type des noms
Namsor fournit une API spécialisée dans la détermination du type d'un nom propre. Elle est formée pour analyser les noms propres et déduire s'il s'agit de noms personnels (anthroponyme), de noms de marques (toponyme) ou de noms de lieux. Différenciez les individus des entreprises en fonction de leur nom afin d'automatiser les processus, d'évaluer les références aux noms ou d'obtenir une meilleure connaissance d'un public. Pour obtenir de meilleurs résultats, vous pouvez indiquer le pays d'origine du nom.
Type Nom
La fonctionnalité Type Nom analyse un nom propre pour déterminer s'il s'agit du nom d'une personne (anthroponyme), d'un nom géographique (toponyme), de l'alias d'une personne (pseudonyme), ou le nom d'une marque. Nous vous recommandons de soumettre le nom complet.
- Description : Estime le type d'un ensemble de noms propres (jusqu'à 100). Ex : Ex: John Smith = anthroponyme, Namsor = nom de marque, Cherbourg en Cotentin = toponyme, Batman = pseudonyme.
- Precision :
- Coût : 1 crédit par nom.
- Tester : Fonctionnalité Type Nom.
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/nameTypeBatchEn-tête de requête
| Propriété | Requis | Description |
|---|---|---|
| X-API-KEY | Requis | Votre clé d'API Namsor |
Corps de la requête
Le corps de la requête HTTP doit être un tableau "properNouns" imbriqué d'objets.
| Nom | Type | Requis | Description |
|---|---|---|---|
| properNouns | Array of objects | Requis | A list of proper names. |
| [{...}].id | String | Optionel | Identifiant unique. |
| [{...}].name | String | Requis | Un nom propre (personne, marque, etc.). |
Réponse
Le corps de la réponse HTTP est un tableau "properNouns" imbriqué d'objets.
| Nom | Type | Description | Énumérateurs |
|---|---|---|---|
| properNouns | Array of objects | A list of commonTypeized names.. | |
| [{...}].script | String | Nom de l'écriture utilisée pour le nom, au format ISO 15924. | Écritures |
| [{...}].id | String | Identifiant unique fourni. | |
| [{...}].name | String | Nom propre renseigné. | |
| [{...}].commonType | String | Type le plus probable du nom propre. | Type du nom |
| [{...}].commonTypeAlt | String | Second type le plus probable du nom propre. | Type du nom |
| [{...}].score | Number | Plus élevé implique un résultat plus fiable, le score n'est pas normalisé. |
Name Type exemple de code pour shell:
curl --request POST \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/nameTypeBatch \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'
--header 'Content-Type: application/json' \
--data '{"properNouns":[{"id":"e630dda5-13b3-42c5-8f1d-648aa8a21c42","name":"Zippo"}]}'Paramètre du corps :
{
"properNouns": [
{
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"name": "Zippo"
}
]
}La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"properNouns": [
{
"script": "LATIN",
"id": "e630dda5-13b3-42c5-8f1d-648aa8a21c42",
"name": "Zippo",
"commonType": "brand-name",
"commonTypeAlt": "toponym",
"score": 7.717552576402805
}
]
}