Documentation de l'API

Chaque institution dispose de sa propre documentation interactive de l’API, disponible sous /docs/ à partir de l’adresse de votre Eduvem - par exemple, https://love.eduvem.com/docs/. C’est le support que l’équipe technique responsable de l’intégration (RH, ERP, BI ou tout autre système externe) utilisera pour découvrir et tester l’API avant d’écrire la moindre ligne de code.

Ce que vous y trouvez

La documentation réunit tous les endpoints de l’API d’intégration : paramètres acceptés, schémas de requête et de réponse, et portées exigées par chaque appel. La page est interactive - vous pouvez déplier n’importe quel endpoint, renseigner les paramètres et envoyer la requête directement depuis le navigateur, avec un jeton réel, sans avoir besoin de Postman ni d’aucun autre outil externe.

Où trouver le lien

Dans l’onglet Intégrations des paramètres de l’institution (Institution > Intégrations), la section Configuration de l’API pour les intégrations propose :

• Le lien Documentation de l’API, qui ouvre le /docs/ de votre institution.
• L’URL de l’API, prête à copier - l’adresse de base utilisée dans chaque appel d’intégration.

Astuce

Chaque institution a sa propre documentation, sur son propre domaine. Si vous administrez ou intégrez plus d’une Eduvem, vérifiez toujours quel /docs/ vous utilisez - celui de chaque institution est différent.

Authentification

Pour tester un appel directement dans la documentation interactive - ou pour configurer une véritable intégration - vous avez besoin d’un jeton d’API valide. La création, la révocation et les portées des jetons se gèrent dans le même onglet Intégrations : voir Jetons de l’API d’intégration. Sans jeton, la documentation reste consultable et chaque endpoint reste visible, mais le bouton d’envoi de la requête renvoie une erreur d’authentification.

Leçons d’un contenu

Une intégration qui traite chaque leçon comme une tâche à part entière - un plan de développement individuel dans un système RH, par exemple - peut consulter la liste des leçons d’un contenu et, par inscription, le statut de chacune :

• GET /integrations/courseVersions/{courseVersionUUID}/lessons renvoie la liste ordonnée et en lecture seule des leçons du contenu publié - les leçons du wizard regroupées par module, les SCOs d’un paquet SCORM, ou l’unité unique d’un coursebox.
• GET /integrations/enrollments/{enrollmentUUID}/lessons renvoie la même liste pour une inscription spécifique, avec le statut « consultée »/« terminée » de chaque leçon et la progression globale de l’inscription.

Les deux appels ont leur propre limite d’utilisation : 120 requêtes par minute, par institution, pour chacun.

Tous les champs, portées et exemples complets de chaque endpoint se trouvent dans la documentation interactive de l’API de votre institution (ci-dessus).

Astuce

L’identifiant de chaque leçon (lessonKey) est l’identité de la leçon ; sa position dans la liste (position) n’est que l’ordre d’affichage - si un auteur réordonne les leçons, la position change, mais le lessonKey reste le même. La stabilité du lessonKey varie aussi selon le type de contenu : les identifiants des leçons du wizard survivent à une republication et restent les mêmes d’une traduction à l’autre. Les identifiants des leçons SCORM, en revanche, sont les chemins de fichiers du paquet SCORM lui-même : les identifiants peuvent changer ou disparaître si le paquet est remplacé par une nouvelle version ou, dans l’appel par inscription, une fois que le premier accès du participant fixe une langue dont le paquet comporte des fichiers différents. Une intégration qui conserve cet identifiant (pour suivre des tâches, par exemple) doit se resynchroniser après l’un de ces changements. La plupart des contenus SCORM n’ont qu’une seule leçon.

Voir aussi

• Jetons de l’API d’intégration