Synchronisation Pégase¶
Le connecteur Pégase permet d’inscrire dans ScoDoc les étudiants connus dans Pégase, à partir des données d’inscription récupérées par l’API Pégase.
Principe général¶
La synchronisation Pégase fonctionne en deux temps.
Une tâche de fond interroge périodiquement l’API Pégase et enregistre localement les inscriptions récupérées dans un fichier JSON, appelé dump Pégase. Ce fichier est stocké côté serveur et sert ensuite de source de données pour les synchronisations ScoDoc.
Lorsqu’un utilisateur lance la synchronisation d’un semestre, ScoDoc ne réinterroge pas directement Pégase : il lit le dernier dump JSON disponible. Cela évite de bloquer l’interface utilisateur avec des appels API potentiellement longs.
Configuration¶
La configuration Pégase permet de renseigner les informations nécessaires aux appels API :
- l’URL d’authentification Pégase ;
- l’URL de base de l’API Pégase ;
- l’utilisateur technique ;
- le mot de passe ;
- le code structure utilisé pour interroger Pégase.
Ces paramètres sont utilisés par la tâche de récupération pour obtenir un jeton JWT, puis interroger les endpoints Pégase.
Dump des inscriptions¶
Le dump des inscriptions est produit par la tâche de fond de récupération Pégase.
Il contient la liste des inscriptions retournées par l’API flux-inscriptions/pagine. Chaque dump est enregistré dans un fichier JSON horodaté. Lors de la synchronisation, ScoDoc utilise le dump le plus récent.
La page de synchronisation indique le dump utilisé, notamment sa date.
Informations récupérées depuis Pégase¶
Pour chaque étudiant, ScoDoc exploite notamment les informations suivantes lorsqu’elles sont présentes dans le dump :
codeApprenant: identifiant Pégase de l’étudiant, utilisé comme clé de rapprochement avec ScoDoc ;INE: code INE ;nomFamille;nomUsage;prenom;civilite;dateDeNaissance;mels: adresses électroniques ;anneeUniversitaire;dateInscription;statutPaiement;chemin: chemin de formation Pégase.
Le codeApprenant est enregistré dans ScoDoc dans le champ code_pegase_apprenant.
Chemins Pégase¶
Un semestre ScoDoc doit être associé à un ou plusieurs chemins Pégase.
Un chemin Pégase est construit à partir du code formation et du code année, sous la forme :
FORMATION>ANNEE
Par exemple :
LIC-DROIT>LIC-DROIT-L2
Lors de la synchronisation, ScoDoc ne retient que les étudiants dont le chemin Pégase correspond à l’un des chemins configurés sur le semestre.
Un semestre peut être associé à plusieurs chemins, ce qui permet de gérer des groupes mixtes ou des regroupements de parcours.
Écran de synchronisation¶
L’écran de synchronisation présente les étudiants répartis en plusieurs catégories :
- étudiants présents dans Pégase et déjà inscrits dans ScoDoc ;
- étudiants présents dans Pégase mais non inscrits dans le semestre ScoDoc ;
- étudiants présents dans Pégase mais inconnus de ScoDoc, à importer ;
- étudiants inscrits dans ScoDoc mais absents du dump Pégase ;
- étudiants ScoDoc sans identifiant Pégase.
L’utilisateur peut sélectionner les étudiants à importer, inscrire ou conserver, puis appliquer les modifications.
Exemple:
Doublons dans le dump¶
Si le dump contient plusieurs entrées avec le même codeApprenant, ScoDoc conserve la dernière occurrence rencontrée dans le fichier JSON.
Réinterrogation manuelle de Pégase¶
La page de statut Pégase permet de relancer manuellement l’interrogation de l’API Pégase. Cette opération démarre une tâche de fond qui produit un nouveau dump JSON.
Une fois le nouveau dump disponible, les synchronisations suivantes utiliseront ce fichier.
Points d’API Pégase utilisés par ScoDoc¶
Les informations dans cette section sont destinées aux développeurs et aux responsables techniques Pégase intéressés.
ScoDoc utilise actuellement un nombre très limité de points d’API Pégase.
Authentification¶
Avant les appels API, ScoDoc demande un jeton JWT à l’URL d’authentification configurée dans l’administration Pégase de ScoDoc.
Requête :
POST <pegase_auth_url>
Content-Type: application/x-www-form-urlencoded
Paramètres envoyés :
username=<utilisateur technique>
password=<mot de passe>
token=true
Le jeton retourné est ensuite utilisé dans les appels Pégase :
Authorization: Bearer <jwt_token>
Accept: application/json
Récupération des inscriptions¶
Utilisé pour produire le dump JSON des inscriptions étudiantes.
GET <pegase_api_base_url>/ins/ext/v2/gestion/flux-inscriptions/pagine
Paramètres actuellement envoyés :
jusqua=0
photo=false
page=<numéro de page>
taille=100
La réponse est paginée. ScoDoc parcourt toutes les pages et agrège les entrées de la clé resultats.
Les données récupérées sont ensuite enregistrées localement dans un fichier JSON horodaté, utilisé par l’écran de synchronisation.
Récupération des chemins de formation¶
Utilisé pour proposer les chemins Pégase associables à un semestre ScoDoc.
GET <pegase_api_base_url>/ins/v1/etablissement/<codeStructure>/<codePeriode>/chemins
Paramètre actuellement envoyé :
inclureFermeInscription=true
codeStructure provient de la configuration Pégase de ScoDoc.
codePeriode correspond à la période Pégase configurée sur le semestre ScoDoc.
Les chemins retournés sont transformés en codes complets de la forme :
FORMATION>ANNEE
Exemple :
LIC-DROIT>LIC-DROIT-L2