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/originBatch
En-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. |