The Dokeos public API is a powerful tool that allows you to seamlessly integrate our Learning Management System (LMS) with your Human Resources Information Systems (HRIS). With this API, you can automate various operations related to users, groups, and training. For instance, you can bulk deactivate learners or retrieve a list of users registered on your portal.
1. Access the Dokeos Public API
The Dokeos API is accessible via a dedicated URL. To access it, follow these steps:
Go to the public API documentation page:
https://monportail.lmsdokeos.com/public_api/docs/index.htmlReplace "monportail" with the name of your Dokeos portal. For example, if your portal is "elearning," the URL becomes:
https://elearning.lmsdokeos.com/public_api/docs/index.html
2. API Authentication
To interact with the API, you need to authenticate using a unique API token, called TENANT_SECRET_TOKEN. This token securely identifies requests coming from your portal.
How to obtain your token?
To obtain your token, please follow these steps:
3. API Endpoints
The Dokeos API offers multiple endpoints to interact with various system entities. Below is an overview of the main available operations.
Users
Retrieve the list of users
Get all users registered on your portal.Create a new user
Add a new user to the system.Activate / deactivate a user
Enable or disable a user as needed.Retrieve user details
Obtain detailed information about a specific user.
Groups
Retrieve the list of groups
Get all user groups defined on the portal.Create a new group
Add a new user group.Update an existing group
Modify the information or members of an existing group.
Training
Enroll a learner in a course
Register a user (learner) for a training program.Retrieve the list of active courses
Get all currently active courses on your portal.Retrieve training/module statistics
Access detailed statistics on a specific training program or module.
This list of API endpoints is not exhaustive. We invite you to consult your Swagger documentation to explore all available API functionalities. If you need additional API endpoints, feel free to contact your project manager to discuss possible implementations.
4. Need Help?
If you have any questions or require further information about the available Dokeos API, feel free to reach out to our support team.
Technical Support: support@dokeos.com
Documentation: You can access the complete documentation anytime on your public API portal.