Projet MonDossierWeb
Pages enfant
  • MDWP -2- APIs Pégase

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

APIvariablesURL exemple
OAuth
url_authn_app_ticketshttps://authn-app.univ.pc-scol.fr/cas/v1/tickets
INS EXT
url_api_ins_ext
https://ins.univ.pc-scol.fr/api/ins/ext/v1
INS
url_api_inshttps://ins.univ.pc-scol.fr/api/v5/ins
CHC
url_api_chc
https://chc.univ.pc-scol.fr/api/chc/v6
COC
url_api_cochttps://coc.univ.pc-scol.fr/api/coc/publication/v1
PAI
url_api_pai
https://pai.univ.pc-scol.fr/api/v1

...

URL (voir variables ci-dessus)Module/APIMéthodeUtilisation

url_authn_app_tickets

serveur OAuth
Récupération du Jeton JWT pour authentification des API
url_api_ins_ext/gestion/inscription/${etab}/${codeApprenant}INS EXTlireInscriptionsRécupération du dossier de l'apprenant et de ses inscriptions
url_api_ins/gestion/inscriptions/${etab}/${codeApprenant}/${codeVoeu}/certificat-de-scolariteINSimprimerCertificatDeScolariteRécupération du certificat de scolarité
url_api_ins_ext/gestion/inscriptions/${etab}/${codeApprenant}/${codeVoeu}/${codePiece}/contenuINS EXTcontenuPieceRécupération de la photo de l'étudiant

url_api_chc/cursus-dca?codeApprenant={codeApprenant}

CHC

lireCursusApprenant

Récupération du cursus
url_api_coc/etablissements/${etab}/periodes/${codePeriode}/apprenants/${codeApprenant}/chemins/${chemin}COClisterCursusPubliableApprenantRécupération des notes et résultats de l'étudiant
url_api_pai/pai/attestation-de-paiement/${etab}/${codeApprenant}/${codePeriode}PAIimprimerAttestationDePaiementRécupération de l'attestation de paiement

...

Bloc de code
languagebash
titleGénération des clients java à partir des yaml
# Forcer l'utilisation de la version 5.4.0  
# /!\ IMPORTANT /!\  A vérifier avant chaque génération sous peine d'obtenir des imports non valides
openapi-generator-cli version-manager set 5.4.0

# INS GESTIONEXT YAML 
npx @openapitools/openapi-generator-cli generate -i insinscription-gestionext-api-v5v1-201.02.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.insgestioninsext -p modelPackage=fr.univlorraine.pegase.model.insgestioninsext -p dateLibrary=java17-localdatetime

# INS EXTGESTION YAML 
npx @openapitools/openapi-generator-cli generate -i inscriptionins-extgestion-api-v1v5-120.20.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.insextinsgestion -p modelPackage=fr.univlorraine.pegase.model.insextinsgestion -p dateLibrary=java17-localdatetime

# CHC YAML
npx @openapitools/openapi-generator-cli generate -i chc-application-api-v5v6-6.2.4.0.yml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.chc -p modelPackage=fr.univlorraine.pegase.model.chc -p dateLibrary=java17-localdatetime --skip-validate-spec

   
# COC PAIPUBLICATION YAML 
npx @openapitools/openapi-generator-cli generate -i paicoc-publication-api-v1v2-162.0.0.yamlyml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.paicoc -p modelPackage=fr.univlorraine.pegase.model.paicoc -p dateLibrary=java17-localdatetime --skip-validate-spec
 
# COCPAI PUBLICATION YAML 
npx @openapitools/openapi-generator-cli generate -i coc-publicationpai-api-v1-121.40.0.ymlyaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.cocpai -p modelPackage=fr.univlorraine.pegase.model.cocpai -p dateLibrary=java17-localdatetime --skip-validate-spec

Récupérer le code généré dans le projet

...