L'abonnement aux API
Les API des Atlas sémantiques
Les Atlas sémantiques ont mis en place un ensemble d’interfaces de programmation d’applications (Application Programming Interfaces, API) qui permettent d’accéder et d’importer des résultats issus de son modèle de représentation géométrique du sens des mots, tels que ceux proposés sur le site web des Atlas sémantiques ou encore d’autres types de résultats spécifique aux API.
Ces résultats précis et originaux peuvent ainsi être intégrés directement dans d’autres sites web ou applications.
Le site web des Atlas sémantiques offre déjà une application gratuite d’une grande partie de ces API. L’accès à ces mêmes API et à d’autres applications originales est proposé sous la forme d’un abonnement. Les abonnements sont personnalisables en fonction des besoins rencontrés que ce soit en termes :
Les Atlas sémantiques ont regroupée leurs API en deux types d’abonnement :
Le site web des Atlas sémantiques offre déjà une application gratuite d’une grande partie de ces API. L’accès à ces mêmes API et à d’autres applications originales est proposé sous la forme d’un abonnement. Les abonnements sont personnalisables en fonction des besoins rencontrés que ce soit en termes :
- de type d’API ;
- de durée d’abonnement ;
- de nombre maximum de requêtes par jour.
Les Atlas sémantiques ont regroupée leurs API en deux types d’abonnement :
Souscrire à un abonnement
Les informations pour souscrire à un abonnement aux API des Atlas sémantiques sont détaillées ci-dessous ainsi que dans le fichier PDF suivant :
Ce dernier contient également un formulaire de demande d’abonnement à remplir et à envoyer à contact@atlas-semantiques.eu.
Dans ce formulaire il est nécessaire de préciser :
Ces informations sont nécessaires à la stricte fin d’édition du contrat d’abonnement. Après l’envoi du formulaire complété, les Atlas sémantiques renverront un devis et le contrat d’abonnement à retourner signés.
L’abonnement débutera à date de signature du contrat par l’ensemble des parties. Une clef de connexion (token) aux API des Atlas sémantiques sera envoyée à cet effet.
Le détail des protocoles à intégrer pour chaque API des Atlas sémantiques est accessible à l'adresse suivante : https://www.atlas-semantiques.eu/v1/
Lors de la souscription à un abonnement, un “access_token” sera fourni. Il est à utiliser lors de chacune de vos requêtes à nos API.
Exemple :
Vous pouvez consulter votre solde de requêtes :
Toutes les requêtes devraient être faites au domaine www.atlas-semantiques.eu (voir exemples).
Le code retour HTTP est 200 sur toutes les réponses valides en json.
À l'intérieur de la réponse, les champs status_code et status_txt indiquent si les requêtes sont valides et bien formées.
Les status_code sont :
Exemples de retours :
Formulaire d'abonnement
Ce dernier contient également un formulaire de demande d’abonnement à remplir et à envoyer à contact@atlas-semantiques.eu.
Dans ce formulaire il est nécessaire de préciser :
- les coordonnées de la personne (physique ou morale) souscrivant à l’abonnement ;
- le type d’abonnement ;
- la durée d’abonnement ;
- le nombre de requêtes journalières ;
- la modalité de paiement (pour un contrat d’un an).
Ces informations sont nécessaires à la stricte fin d’édition du contrat d’abonnement. Après l’envoi du formulaire complété, les Atlas sémantiques renverront un devis et le contrat d’abonnement à retourner signés.
L’abonnement débutera à date de signature du contrat par l’ensemble des parties. Une clef de connexion (token) aux API des Atlas sémantiques sera envoyée à cet effet.
Le détail des protocoles à intégrer pour chaque API des Atlas sémantiques est accessible à l'adresse suivante : https://www.atlas-semantiques.eu/v1/
Méthode d'authentification
La méthode d'authentification choisie (pour l'instant) est la plus simple possible :Lors de la souscription à un abonnement, un “access_token” sera fourni. Il est à utiliser lors de chacune de vos requêtes à nos API.
Exemple :
curl “https://www.atlas-semantiques.eu/v1/synonyms?apitoken=ACCESS_TOKEN&expr=rue&dict=FR&limit=3&order=rank”Vous pouvez consulter votre solde de requêtes :
curl “https://www.atlas-semantiques.eu/v1/subscriptions?apitoken=ACCESS_TOKEN”Format de requête et de réponse
Les API des Atlas sémantiques ne renvoient que des données au format json.Toutes les requêtes devraient être faites au domaine www.atlas-semantiques.eu (voir exemples).
Le code retour HTTP est 200 sur toutes les réponses valides en json.
À l'intérieur de la réponse, les champs status_code et status_txt indiquent si les requêtes sont valides et bien formées.
Les status_code sont :
- 200 pour une requête réussie
- 403 pour un taux de requetes anormal
- ...
Exemples de retours :
json { "status_code": 200, "status_txt": "OK", "data" : ... }
json { "status_code": 400, "status_txt": "MISSING_ARG_LOGIN", "data" : null }
json { "status_code": 403, "status_txt": "RATE_LIMIT_EXCEEDED", "data" : null }
json { "status_code": 500, "status_txt": "UNKNOWN ERROR", "data" : null }
json { "status_code": 503, "status_txt": "TEMPORARILY_UNAVAILABLE", "data" : null }Remarque importante
L’offre d’API des Atlas sémantiques est toujours en cours d’enrichissement. À tout moment vous pouvez contacter les Atlas sémantiques pour discuter du développement d’une ou plusieurs API personnalisée(s) et adaptée(s) à vos besoins à l’adresse : contact@atlas-semantiques.eu.Abonnement : API générales
Les API générales recouvrent l’ensemble des API qui sont à la base des fonctionnalités du site web des Atlas sémantiques. L’utilisation des barres de recherches présentes sur l’ensemble des pages web des Atlas sémantiques vous donne un aperçu d’applications et de résultats permis par ces API.
Les Atlas sémantiques continuent d’enrichir leurs contenus (mises à jour, ajouts,…). Toute souscription aux API générales bénéficiera automatiquement de ces enrichissements sans qu’il soit nécessaire de modifier les termes de l’abonnement.
| API | Description | Langue |
|---|---|---|
| Synonyms | Renvoie la liste des synonymes et parasynonymes d'un mot (ou d'une expression) dans la langue choisie ainsi qu’un coefficient de généricité pour chaque synonyme |
|
| Antonyms | Renvoie la liste des antonymes (contraires et opposés) d'un mot (ou d'une expression) dans la langue choisie |
|
| Categories | Renvoie la liste des catégories grammaticales, genre et nombre d'un mot dans le dictionnaire choisi |
|
| Derivatives | Renvoie la liste des flexions d'un mot (ou d'une expression) dans la langue choisie et une mesure de la fréquence pour chaque flexion |
|
Subscriptions |
Renvoie la quantité de requêtes quotidiennes et la consommation actuelle |
Remarques importantes
Un abonnement souscrit aux API générales donne indistinctement accès à l’ensemble des API de ce type. L’exploitation de l’ensemble ou seulement d’une partie de ces API est à la discrétion de la personne abonnée.Les Atlas sémantiques continuent d’enrichir leurs contenus (mises à jour, ajouts,…). Toute souscription aux API générales bénéficiera automatiquement de ces enrichissements sans qu’il soit nécessaire de modifier les termes de l’abonnement.
Abonnement : API avancées
Les API avancées recouvrent l’ensemble des API données dans la liste ci-dessous. L’abonnement à ces API inclut l’accès aux API générales.
Les Atlas sémantiques continuent d’enrichir leurs contenus (mises à jour, ajouts,…). Toute souscription aux API avancées bénéficiera automatiquement de ces enrichissements, ce soit pour les API générales ou les API avancées, sans qu’il soit nécessaire de modifier les termes de l’abonnement.
| API | Description | Langue |
|---|---|---|
| Synonyms-in-list | Donne parmi une liste de mots ceux qui sont synonymes (ou parasynonymes) entre eux | |
| Antonyms-in-list | Donne parmi une liste de mots ceux qui sont antonymes (contraires et opposés) entre eux | |
API personnalisée |
L’offre d’API des Atlas sémantiques est toujours en cours d’enrichissement. |
Remarques importantes
Un abonnement souscrit aux API avancées donne indistinctement accès à l’ensemble des API proposées par les Atlas sémantiques. L’exploitation de l’ensemble ou seulement d’une partie des API est à la discrétion de la personne abonnée.Les Atlas sémantiques continuent d’enrichir leurs contenus (mises à jour, ajouts,…). Toute souscription aux API avancées bénéficiera automatiquement de ces enrichissements, ce soit pour les API générales ou les API avancées, sans qu’il soit nécessaire de modifier les termes de l’abonnement.
Tarifs de l'abonnement
Les tarifs d’un abonnement aux API des Atlas sémantiques sont établis sur un forfait mensuel en fonction du type d’API souscrites ainsi que du nombre maximum de requêtes journalières.
Les Atlas sémantiques proposent plusieurs paliers en fonction du nombre maximum de requêtes journalières.
Le détail de ces informations est rappelé à l’annexe 2 : grille tarifaire téléchargeable ci-dessous. Ce document accompagne tout contrat d’abonnement.
*Cette réduction n’est pas proposée pour les abonnements de 200 requêtes maximales quotidiennes.
Les Atlas sémantiques proposent plusieurs paliers en fonction du nombre maximum de requêtes journalières.
| Nombre max. requêtes/jour |
200 | 1000 | 2000 | 5000 | 10000 | 30000 |
|---|---|---|---|---|---|---|
| Tarif API générales/mois |
4,99€ | 24,99€ | 49,99€ | 79,99€ | 119,99€ | 199,99€ |
| Tarif API avancées/mois |
7,99€ | 39,99€ | 79,99€ | 149,99€ | 199,99€ | 299,99€ |
Le détail de ces informations est rappelé à l’annexe 2 : grille tarifaire téléchargeable ci-dessous. Ce document accompagne tout contrat d’abonnement.
Grille tarifaire API
Remarques importantes
Les Atlas sémantiques proposent deux tarifications préférentielles :- 1 mois d’abonnement offert pour toute souscription à un abonnement d’un an ;
- 50 % de réduction* sur les abonnements souscrits par des personnels académiques, universitaires, de la recherche, de bibliothèque, de médiathèque et de la documentation.
*Cette réduction n’est pas proposée pour les abonnements de 200 requêtes maximales quotidiennes.
Durée de l'abonnement
Les abonnements aux API des Atlas sémantiques peuvent être établis sur deux durées :
Les abonnements aux API des Atlas sémantiques doivent être réglés par prélèvement bancaire. Un contrat établi sur une durée d’un an avec annualisation de son règlement peut être réglé par virement bancaire.
- une durée indéterminée. L’abonnement est alors mensualisé à partir de la date de signature du contrat ;
- une durée de 1 an offrant la possibilité de régler l’abonnement de façon mensuelle sur la base d’un échéancier ou annuelle. L’abonnement est à renouveler à échéance.
Les abonnements aux API des Atlas sémantiques doivent être réglés par prélèvement bancaire. Un contrat établi sur une durée d’un an avec annualisation de son règlement peut être réglé par virement bancaire.