L'API publique de Dokeos est un outil puissant qui vous permet d'intégrer facilement notre Learning Management System (LMS) avec vos systèmes de gestion des ressources humaines (SIRH). Grâce à cette API, vous pouvez automatiser une variété d'opérations concernant les utilisateurs, les groupes et les formations. Par exemple, il est possible de désactiver des apprenants en masse ou de récupérer la liste des utilisateurs inscrits sur votre portail.
1. Accéder à l'API Publique de Dokeos
L'API de Dokeos est accessible via une URL dédiée. Pour y accéder, suivez les étapes suivantes :
Rendez-vous sur la page de documentation de l'API publique :
https://monportail.lmsdokeos.com/public_api/docs/index.htmlRemplacez
monportailpar le nom de votre portail Dokeos. Par exemple, si votre portail estelearning, l'URL devient :
https://elearning.lmsdokeos.com/public_api/docs/index.html
2. Authentification à l'API
Pour interagir avec l'API, vous devez vous authentifier en incluant un token API unique, appelé TENANT_SECRET_TOKEN. Ce token permet à Dokeos d'identifier de manière sécurisée les requêtes provenant de votre portail.
Comment obtenir votre token ?
Pour obtenir votre token, Veuillez suivre ces étapes :
3. Points de Terminaison de l'API
L'API de Dokeos propose plusieurs points de terminaison pour interagir avec les différentes entités du système. Voici un petit aperçu des principales opérations disponibles.
Utilisateurs
Obtenir la liste des utilisateurs
Permet de récupérer tous les utilisateurs inscrits sur votre portail.Créer un nouvel utilisateur
Crée un nouvel utilisateur dans le système.Activer / désactiver un utilisateur
Permet d'activer ou de désactiver un utilisateur en fonction de vos besoins.Récupérer les détails d'un utilisateur
Obtenez les informations détaillées sur un utilisateur spécifique.
Groupes
Obtenir la liste des groupes
Permet d'obtenir tous les groupes d'utilisateurs définis sur le portail.Créer un nouveau groupe
Crée un nouveau groupe d'utilisateurs.Mettre à jour un groupe existant
Permet de modifier les informations ou les membres d'un groupe existant.
Formations
Inscrire un apprenant à une formation
Inscrit un utilisateur (apprenant) à une formation.Obtenir la liste des formations actives
Permet de récupérer toutes les formations actuellement actives sur votre portail.Obtenir les statistiques d'une formation / module
Permet de récupérer les statistiques détaillées sur les performances d'une formation ou d'un module spécifique.
Cette liste d'API n'est pas exhaustive. Nous vous invitons à consulter votre Swagger pour découvrir toutes les possibilités d'API disponibles. En cas de besoin, n'hésitez pas à contacter votre chef de projet pour discuter d'un éventuel besoin de mise en place de nouvelles API.
4. Besoin d'Aide ?
Si vous avez des questions ou avez besoin de plus d'informations concernant l'API disponoibles de Dokeos, n'hésitez pas à contacter notre équipe de support.
Support technique : support@dokeos.com
Documentation : Vous pouvez consulter la documentation complète à tout moment sur le portail de votre API publique.