API Admin – Gérer votre compte et vos clés API
L'API Admin de Namsor vous permet de gérer votre compte et vos clés API.
Statut API
GET- Coût: 1 crédit par nom.
- Description : Renvoie la version actuelle du logiciel Namsor et l'État des classificateurs (services API).
- Plus d'informations sur : Statut API
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/apiStatus| Propriété | Requis | Description |
|---|---|---|
X-API-KEY | Requis | Votre clé d'API Namsor |
Pour obtenir une clé d'API gratuite, veuillez créer un compte.
| Nom | Type | Description |
|---|---|---|
softwareVersion | Object | Informations sur la version du logiciel. |
softwareNameAndVersion | String | Nom et version de l'API. |
softwareVersion | Array | Version du logiciel, sous forme de tableau (majeur, mineur et patch). |
classifierName | String | Nom du classificateur / service. |
serving | Boolean | Vrai si le classificateur traite des requêtes (a atteint un apprentissage minimal, ne s'arrête pas). |
learning | Boolean | Vrai si le classificateur apprend. |
shuttingDown | Boolean | Vrai si le classificateur est en train de s'arrêter. |
probabilityCalibrated | Boolean | Vrai si le classificateur a terminé l'apprentissage initial et a des probabilités calibrées (lors de l'apprentissage initial, les probabilités calibrées seront égales à -1). |
Exemples d'intégration:
Api Status exemple de code pour shell:
curl --request GET \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/apiStatus \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"softwareVersion": {
"softwareNameAndVersion": "NamSorAPIv2.0.14B01",
"softwareVersion": [
2,
0,
14
]
},
"classifiers": [
{
"classifierName": "name_category",
"serving": true,
"learning": true,
"shuttingDown": false,
"probabilityCalibrated": false
},
{
"classifierName": "personalname_gender",
"serving": true,
"learning": true,
"shuttingDown": false,
"probabilityCalibrated": true
}
]
}Utilisation API
GET- Coût: 1 crédit par nom.
- Description : Renvoie des informations sur votre plan d'abonnement, la période de facturation et l'utilisation actuelle de l'API.
- Plus d'informations sur : Utilisation API
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/apiUsage| Propriété | Requis | Description |
|---|---|---|
X-API-KEY | Requis | Votre clé d'API Namsor |
Pour obtenir une clé d'API gratuite, veuillez créer un compte.
| Nom | Type | Description |
|---|---|---|
subscription | Object | Information sur l'abonnement. |
apiKey | String | Votre clé API Namsor. |
planStarted | Number | Date de début du forfait, au format horaire UNIX. |
priorPlanStarted | Number | Date et heure à laquelle l'utilisateur s'est abonné au forfait précédent. |
planEnded | Number | Date de fin du forfait, au format horaire UNIX. |
taxRate | Number | Taux d'imposition applicable au forfait. |
planName | String | Nom du forfait. |
planBaseFeesKey | String | Clé du plan actuel (comme dans le produit Stripe). |
planStatus | String | Statut du forfait. |
planQuota | Number | Nombre total de crédits associés à ce plan. |
priceUSD | Number | Prix en dollars américains ($). |
priceOverageUSD | Number | Prix de l'acquisition d'un credit en dollars américains ($). |
price | Number | Prix dans la devise préférée de l'utilisateur. |
priceOverage | Number | Prix total de l'acquisition de crédits supplémentaires dans la devise préférée de l'utilisateur. |
currency | String | La devise préférée de l'utilisateur. |
currencyFactor | Number | Pour USD, GBP, EUR - le facteur est 1. |
stripeCustomerId | String | Identifiant client Stripe unique. |
stripeStatus | String | Statut Stripe. |
stripeSubscription | String | Identifiant d'abonnement Stripe. |
userId | String | Identifiant utilisateur unique. |
billingPeriod | Object | Détails de facturation. |
apiKey | String | Votre clé API Namsor. |
subscriptionStarted | Number | Date de début de l'abonnement, au format horaire UNIX. |
periodStarted | Number | Date de début de la période d'abonnement, au format horaire UNIX. |
periodEnded | Number | Date de fin d'abonnement, au format horaire UNIX. |
stripeCurrentPeriodEnd | Number | Fin du plan actuel dans Stripe. |
stripeCurrentPeriodStart | Number | Début du plan actuel dans Stripe. |
billingStatus | String | État de la facturation pour la période en cours. |
usage | Number | Nombre de crédits utilisés jusqu'à présent. |
softLimit | Number | Limite flexible actuelle. |
hardLimit | Number | Limite stricte actuelle. |
overageExclTax | Number | Montant total d'acquisition des crédits supplémentaires hors taxe. |
overageInclTax | Number | Montant total d'acquisition des crédits supplémentaires toutes taxes comprises. |
overageCurrency | String | Devise du montant total d'acquisition des crédits supplémentaires. |
overageQuantity | Number | Quantité de crédits consommés supérieure au quota mensuel de l'abonnement en cours. |
Exemples d'intégration:
Api Usage exemple de code pour shell:
curl --request GET \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/apiUsage \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"subscription": {
"apiKey": "v7menlws2yo8r2mnm10f3uai53tmblth",
"planStarted": 1602705605199,
"priorPlanStarted": 0,
"planEnded": 0,
"taxRate": 0,
"planName": "BASIC",
"planBaseFeesKey": "namsorapi_v2_BASIC_usd",
"planStatus": "OPEN",
"planQuota": 5000,
"priceUSD": 0,
"priceOverageUSD": 0.005,
"price": 0,
"priceOverage": 0.005,
"currency": "usd",
"currencyFactor": 1,
"stripeCustomerId": null,
"stripeStatus": null,
"stripeSubscription": null,
"userId": "GYUAUzTKPusJ3aqUH5gQte0dOQCr"
},
"billingPeriod": {
"apiKey": "v7menlws2yo8r2mnm10f3uai53tmblth",
"subscriptionStarted": 1602705635199,
"periodStarted": 1618430435199,
"periodEnded": 0,
"stripeCurrentPeriodEnd": 0,
"stripeCurrentPeriodStart": 0,
"billingStatus": "OPEN",
"usage": 34,
"softLimit": 3000,
"hardLimit": 5000
},
"overageExclTax": 0,
"overageInclTax": 0,
"overageCurrency": null,
"overageQuantity": 0
}Services Disponibles
GET- Coût: 1 crédit par nom.
- Description : Renvoie une liste des services API (classificateurs) et leurs coûts d'utilisation en crédits.
- Plus d'informations sur : Services Disponibles
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/apiServices| Propriété | Requis | Description |
|---|---|---|
X-API-KEY | Requis | Votre clé d'API Namsor |
Pour obtenir une clé d'API gratuite, veuillez créer un compte.
| Nom | Type | Description |
|---|---|---|
serviceName | String | Nom du classificateur / service. |
serviceGroup | String | Groupe auquel appartient le classificateur/service. |
costInUnits | Number | Coût d'utilisation du service, en crédits. |
Exemples d'intégration:
Available Services exemple de code pour shell:
curl --request GET \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/apiServices \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"serviceName": "name_category",
"serviceGroup": "general",
"costInUnits": 1
}Version Logiciel
GET- Coût: 1 crédit par nom.
- Description : Renvoie la version actuelle du logiciel Namsor.
- Plus d'informations sur : Version Logiciel
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/softwareVersion| Propriété | Requis | Description |
|---|---|---|
X-API-KEY | Requis | Votre clé d'API Namsor |
Pour obtenir une clé d'API gratuite, veuillez créer un compte.
| Nom | Type | Description |
|---|---|---|
softwareNameAndVersion | String | Nom et version de l'API. |
softwareVersion | Array | Version du logiciel, sous forme de tableau (majeur, mineur et patch). |
Exemples d'intégration:
Software Version exemple de code pour shell:
curl --request GET \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/softwareVersion \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"softwareNameAndVersion": "NamSorAPIv2.0.14B01",
"softwareVersion": [
2,
0,
14
]
}Classes de Taxonomie
GET- Coût: 1 crédit par nom.
- Description : Renvoie une liste des énumérateurs possibles pour un classificateur donné.
- Plus d'informations sur : Classes de Taxonomie
Requête HTTP
https://v2.namsor.com/NamSorAPIv2/api2/json/taxonomyClasses/{classifierName}| Propriété | Requis | Description |
|---|---|---|
X-API-KEY | Requis | Votre clé d'API Namsor |
Pour obtenir une clé d'API gratuite, veuillez créer un compte.
| Nom | Type | Requis | Description |
|---|---|---|---|
classifierName | String | Requis | Nom du classificateur. |
| Nom | Type | Description |
|---|---|---|
classifierName | String | Nom du classificateur soumis. |
taxonomyClasses | Array | Énumérateurs possibles pour ce classificateur. |
Exemples d'intégration:
Taxonomy Classes exemple de code pour shell:
curl --request GET \
--url https://v2.namsor.com/NamSorAPIv2/api2/json/taxonomyClasses/personalname_gender \
--header 'X-API-KEY: your-api-key' \
--header 'Accept: application/json'La commande ci-dessus renvoie un JSON structuré comme ceci :
{
"classifierName": "personalname_gender",
"taxonomyClasses": ["female", "male"]
}