Chers clients,
Dokeos oeuvre au quotidien pour l'amélioration des performances de son LMS. Dans cette optique, l'équipe produit travaille sans relâche depuis plusieurs mois sur plusieurs axes de la plateforme et notamment les points d'API.
Si vous utilisez Dokeos en intégration avec d'autres systèmes et utilisez les API pour effectuer les échanges, cet article est important et il est possible que vous deviez effectuer quelques vérifications dans vos mécanismes.
Nous ne vous laissons évidemment pas livrés à vous-mêmes et sommes tout à fait disposés à vous accompagner et aiguiller sur ces changements. N'hésitez pas à prendre contact avec votre chef de projet Dokeos qui planifiera un rendez-vous avec les personnes concernées.
Attention, les changements mentionnés ci-dessous seront effectifs en production à partir du 30 septembre 2024. Si vous désirez effectuer des tests et validations avant cette date, veuillez le mentionner à votre chef de projet
Décommissionnement de l'API V1
En consultant votre documentation API, vous pouvez choisir l'API V1 ou l'API V2 en haut à droite. Par défaut, c'est la seconde version qui est affichée. C'est aussi celle qui bénéficie de toutes les nouveautés, mises à jour, etc.
Cette version 1, va être complètement retirée de nos services le 30 septembre 2024.
Pour savoir si vous êtes sur la V1 ou la V2, il suffit de vérifier la valeur de votre "ACCEPT" dans le header de vos appels API.
ACCEPT = application/vnd.dokeos+json;version=1
Ceci signifie que vous êtes en V1.
ACCEPT = application/vnd.dokeos+json;version=2
Ceci signifie que vous êtes déjà bien en V2.
Pour migrer votre système de l'usage de la V1 vers la V2, veuillez consulter la documentation respective de chaque version pour constater les changements.
Attention, certains appels feront également l'objet d'autres changements mentionnés ci-dessous.
En parallèle de ce décommissionnement, nous avons quelques changements sur l'API V2 à appliquer également. En voici le détail :
GET /participations
Par défaut, une page contiendra 20 éléments
L'attribut "progressions" qui contient l'évolution d'un apprenant par module ne sera plus retourné par défaut. Si vous devez lire les progressions, il faudra ajouter à l'appel
?response_attributes=progressions
Le champ "training_ids" ne peut pas contenir plus de 5 éléments
Le champ "user_ids" ne peut pas contenir plus de 5 éléments
GET/ participations/:id
L'attribut "progressions" qui contient l'évolution d'un apprenant par module ne sera plus retourné par défaut. Si vous devez lire les progressions, il faudra ajouter à l'appel
?response_attributes=progressions
GET /users
Par défaut, une page contiendra 20 éléments
Les attributs "group_ids", "role_names", "tag_ids" et "skills" ne sont plus retournés par défaut. Si vous devez lire ces informations, il faudra ajouter à l'appel
?response_attributes=group_ids,role_names,tag_ids,skills
DELETE /user/:id
Le processus de suppression sera fait de manière asynchrone. L'API retournera une valeur "job_id" qui vous permettra de vérifier le statut de traitement de la requête. Ce "job_id" a une durée de vie d'une semaine.
Pour consulter le statut de la requête, un nouveau point d'appel a été créé :/jobs/:job_id
PUT /presence_sessions/:id/sync & PUT /presence_sessions/sync
PUT /webinar_sessions/:id/sync & PUT /webinar_sessions/sync
Le processus de synchronisation sera fait de manière asynchrone. L'API retournera une valeur "job_id" propre à chaque session qui vous permettra de vérifier le statut de traitement de la requête.
Ce "job_id" a une durée de vie d'une semaine.
Pour consulter le statut de la requête, un nouveau point d'appel a été créé :/jobs/:job_id
GET /groups
Par défaut, une page contiendra 20 éléments
POST/PUT /groups
Les actions suivantes se feront de manière asynchrone. L'API retournera une valeur "job_id" qui vous permettra de vérifier le statut de traitement de la requête.
Ce "job_id" a une durée de vie d'une semaine.
Pour consulter le statut de la requête, un nouveau point d'appel a été créé :/jobs/:job_id
Ajout/suppression d'un apprenant
Ajout/Suppression d'un responsable
Création/suppression d'une participation
PUT /training_gate/:id
Modifier la training_gate se fera de manière asynchrone. L'API retournera une valeur "job_id" qui vous permettra de vérifier le statut de traitement de la requête.
Ce "job_id" a une durée de vie d'une semaine.
Pour consulter le statut de la requête, un nouveau point d'appel a été créé :/jobs/:job_id
Nous vous remercions de votre compréhension et de votre collaboration sur ce sujet.
Soyez assurés de notre entier dévouement à rendre l'infrastructure toujours plus fiable et plus performante.
Nous restons à votre service pour vous apporter toute l'aide nécessaire.
L'équipe produit de Dokeos.