Une API ouverte, ou API publique, est, pour aller à l'essentiel et pour faciliter sa définition, un pont directs entre des logiciels permettant d'interagir et de partager des données.
Notre API vous permet donc d'automatiser de nombreuses opérations (cf. plus bas le point "Routes") liées aux utilisateurs, aux groupes et aux formations avec notre LMS (exemple : désactiver des apprenants en masse ou récupérer la liste des utilisateurs du portail).
Pour avoir accès à l’API publique de Dokeos :
Rendez-vous sur la page : https://monportail.lmsdokeos.com/public_api/docs/index.html en remplacant « monportail » par le nom de votre portail (ou ajoutez simplement « /public_api/docs/index.html » à la suite de l’url de votre portail.
Exemple:
Mon portail s’appelle :
https://svanderbeck.lmsdokeos.com
du coup, l'url devient : https://svanderbeck.lmsdokeos.com/public_api/docs/index.html
Authentification
Il faut que les requêtes envoyées à l’API indiquent le token API du portail (= TENANT_SECRET_TOKEN). Cela permet de reconnaître à quel portail Dokeos on s’adresse. C'est une sorte de code d’identification unique.
Pour connaître ces éléments, contactez support@dokeos.com ou votre chef de projet.
Les routes
Notre API a été conçue pour vous proposer un large choix de possibilités d'intégration.
Voici une liste reprenant quelques routes disponibles dans notre API :
Utilisateurs
Obtenir la liste des utilisateurs
Créer un nouvel utilisateur
Activer / désactiver un utilisateur
Récupérer les détails d'un utilisateur
Groupes
Obtenir la liste des groupes
Créer un nouveau groupe
Mettre à jour un groupe existant
Formations
Inscrire un apprenant à une formation
Obtenir la liste des formations actives
Remonter les statistiques d'une formation / d'un module
Pour plus d'information concernant l'API, n'hésitez pas à nous contacter.