...
Pour des exemples d'appels aux APIs effectués grâce aux classes générées ci-dessus, voir le code source du PegaseService sur github : https://github.com/EsupPortail/esup-mdw-pegase/blob/master/src/main/java/fr/univlorraine/mondossierweb/service/PegaseService.java
Tester une API à la main
| Info |
|---|
| Plutôt que d'utiliser la commande "curl" pour executer les requêtes http, il possible d'utiliser un outil comme Postman afin de se faciliter la tâche. |
Appeler une API s'effectue via une requête HTTP.
Pour être autorisé à appeler l'API d'un module Pégase, il faut préalablement avoir récupéré un token d'authentification.
Par exemple pour tester la méthode lireInscriptions de l'API INS (qui retourne la quasi totalité du dossier), il faut :
- faire un premier appel (POST) au serveur OAuth pour récupérer le token
- utiliser ce token pour appeler l'API (GET)
Récupération du token
POST https://authn-app.[univ].pc-scol.fr/cas/v1/tickets?username=[id]&password=[pwd]
Appel de l'API
GET https://ins.[univ].pc-scol.fr/api/v5/ins/gestion/inscription/[codeEtablissement]/[codeApprenant]/
Ajouter la chaîne "Bearer " (attention à bien ajouter l'espace) au début du token et le passer dans un header nommé "Authorization".
| Info |
|---|
| Via Postman le passage du token se fait facilement depuis l'onglet "Authorization" (Type "OAuth 2.0") |