| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente |
| adel:utilisateurs:api-rest [2021/02/16 13:47] – julien.lanfrey | adel:utilisateurs:api-rest [2022/06/13 14:48] (Version actuelle) – eric |
|---|
| ===== Introduction ===== | ===== Introduction ===== |
| |
| Adel met à disposition depuis 2021 ce qu'on appelle une "API REST". De manière résumée, une API est une solution informatique qui permet à des applications de communiquer entre elles, de s'échanger des informations. Une API met à disposition un ensemble de fonctions qui facilitent l'accès aux services fournis par une application. L'échange d'informations s'effectue à travers un langage de programmation. | Adel met à disposition depuis 2021 ce qu'on appelle une "API REST". De manière résumée, une API est une solution informatique qui permet à des applications de communiquer entre elles, de s'échanger des informations. |
| | |
| | Une API met à disposition un ensemble de fonctions qui facilitent l'accès aux services fournis par une application. L'échange d'informations s'effectue à travers un langage de programmation. |
| |
| Le terme "[[https://fr.wikipedia.org/wiki/Representational_state_transfer|REST]]" désigne le style d'architecture de l'API. Nous ne la détaillerons pas ici. | Le terme "[[https://fr.wikipedia.org/wiki/Representational_state_transfer|REST]]" désigne le style d'architecture de l'API. Nous ne la détaillerons pas ici. |
| ===== Notes de version ===== | ===== Notes de version ===== |
| |
| * Dernière mise à jour de ce document : **le 16 février 2021** | * Dernière mise à jour de ce document : **le 9 septembre 2021** |
| | * Clarification de la forme de l'URL attendue au niveau de l'implémentation |
| * Version d'Adel utilisé lors des tests : **6.4.6** | * Version d'Adel utilisé lors des tests : **6.4.6** |
| * Version de l'API : **v1** | * Version de l'API : **v1** |
| ===== Documentation OpenAPI ===== | ===== Documentation OpenAPI ===== |
| |
| La documentation technique de l'API est disponible en ligne à l'adresse suivante :\\ | L'accès à la documentation technique de l'annuaire ADEL est le suivant :\\ |
| [[https://www.bayard-service.com|Documentation technique de l'API]] | **<nowiki>https://secure.bayard-service.com/annuaire_<MON_ANNUAIRE>/swagger-ui/index.html</nowiki>** |
| |
| Cette documentation repose sur le standard [[https://www.openapis.org|OpenAPI]] et met à disposition une interface permettant de découvrir les possibilités de l'API mais aussi de **tester les différents services** offerts par celle-ci. | Cette documentation repose sur le standard [[https://www.openapis.org|OpenAPI]] et met à disposition une interface permettant de découvrir les possibilités de l'API mais aussi de **tester les différents services** offerts par celle-ci. |
| Les requêtes effectuées sur l'API nécessitent une authentification afin que l'API soit en mesure d'accéder aux données de votre base Adel. C'est pourquoi l'interface de la documentation technique en ligne affiche un bouton "//Authorize//" avec un cadenas ouvert qui précise que vous n'êtes pas encore authentifié. | Les requêtes effectuées sur l'API nécessitent une authentification afin que l'API soit en mesure d'accéder aux données de votre base Adel. C'est pourquoi l'interface de la documentation technique en ligne affiche un bouton "//Authorize//" avec un cadenas ouvert qui précise que vous n'êtes pas encore authentifié. |
| |
| Pour pouvoir tester les différentes routes, il est donc nécessaire d'être authentifié. Pour cela, cliquez sur le bouton pour renseigner les informations d'identification. | Pour pouvoir tester les différentes "routes", il est donc nécessaire de l'être. Pour cela, cliquez sur le bouton pour renseigner les informations d'identification. |
| * ''username'' et ''password'' : correspondent à un compte d'accès Adel. Ce compte doit être habilité à utiliser l'API. | * ''username'' et ''password'' : correspondent à un compte d'accès Adel. Ce compte doit être habilité à utiliser l'API. |
| * ''client-id'' et ''client-secret'' : Mécanisme complémentaire d'authentification. Les informations à saisir sont à demander à Bayard-Service. | * ''client-id'' et ''client-secret'' : Mécanisme complémentaire d'authentification. Les informations à saisir sont à demander à Bayard-Service. |
| |
| Ces 4 champs étant renseignés, cliquez sur le bouton "Authorize" au bas du formulaire. Le résultat de l'opération s'affiche. Fermez cette petite fenêtre. Le cadenas est alors fermé ce qui indique que l'authentification a réussi. Vous êtes désormais en mesure de tester les différentes routes. | Ces 4 champs étant renseignés, cliquez sur le bouton "Authorize" au bas du formulaire. Le résultat de l'opération s'affiche. Fermez cette petite fenêtre. Le cadenas est alors fermé ce qui indique que l'authentification a réussi. Vous êtes désormais en mesure de tester les différentes "routes". |
| |
| Le mécanisme d'authentification est expliqué plus en détail dans la partie [[adel:utilisateurs:api-rest:implementation|Implémentation]]. | Le mécanisme d'authentification est expliqué plus en détail dans la partie [[adel:utilisateurs:api-rest:implementation|Implémentation]]. |