Ressources numériques en sciences humaines et sociales OpenEdition Nos plateformes OpenEdition Books OpenEdition Journals Hypothèses Calenda Bibliothèques OpenEdition Freemium Suivez-nous

Notice openAPI

 

Documentation OpenAPI

 

Système de clé d’API

Pour assurer la sécurité au niveau de l’API REST lors de l’écriture de nouveaux candidats, un système de clé d’API a été mis en place pour identifier l’auteur de chaque candidat.

Par défaut cette clé n’est accessible que pour les personnes autorisées.

Avoir accès à une clé d’API

Pour avoir accès à sa clé API, il est nécessaire de faire une demande à un administrateur (voir rubrique ci-dessous).

Une fois cette demande acceptée, rendez-vous sur la page de modification de compte:

Une rubrique clé d’API devrait y apparaître contenant un bouton permettant de générer/regénérer une clé d’API. La date d’expiration de votre clé apparaîtra aussi.

Attention à bien copier la clé car une fois la page fermée, vous devrez en générer une autre.

Administrateurs : comment autoriser un utilisateur à avoir une clé d’API

Pour autoriser un utilisateur à avoir une clé d’API, rendez-vous sur la page de gestion des utilisateurs :

 

 

Une fois sur cette page, cliquez sur modifier pour l’utilisateur souhaité :

 

 

Une fois arrivé sur la page de modification de l’utilisateur, cochez la case “Peut avoir une clé d’API” :

 

 

Une fois cette case cochée, des options s’offrent à vous comme le fait de donner à l’utilisateur une clé définitive ou de définir une date d’expiration à la clé d’API :

 

Une fois les options définies, cliquez sur appliquer pour sauvegarder les changements sur l’utilisateur.

Utilisation de la clé d’API

La clé d’API s’utilise lorsqu’on fait une requête à l’API d’OpenTheso.

Ici suivra une description de la requête à faire pour créer un nouveau candidat sur un thésaurus.

Il faut d’abord savoir que la clé est reliée à l’utilisateur qui la possède. Ce qui veut dire que si un utilisateur n’a pas les autorisations nécessaires sur un thésaurus, il ne pourra pas faire de requêtes pour créer un nouveau candidat.

Headers

Pour les headers de la requête, il faut ajouter aux headers de base un header nommé “API-KEY” et de lui donner comme valeur la clé d’API de l’utilisateur.

Exemple avec Postman (client recommandé pour les tests) :

Corps

Pour le corps de la requête, le format choisit est le JSON. Pour ajouter un candidat, le JSON doit contenir 3 champs obligatoires et un champ optionnel.

Les champs obligatoires sont :

  • title : titre du candidat
  • definition : définition du candidat
  • thesoId : id du thésaurus auquel ajouter le candidat

Le champ optionnel est le champs source qui doit contenir la source du candidat.

Exemple du corps d’une requête avec Postman :


OpenEdition vous propose de citer ce billet de la manière suivante :
tomcourtet (22 juillet 2024). Notice openAPI. Opentheso. Consulté le 7 juin 2026 à l’adresse https://doi.org/10.58079/122ja


Vous aimerez aussi...

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

This site uses Akismet to reduce spam. Learn how your comment data is processed.