Introduction

L'intégration de l'API améliore considérablement l'expérience utilisateur des enseignants utilisant ChallengeMe.

L'intégration Moodle utilise l'intégration de l'API REST avec un compte de service étendu.

Configuration de l'API REST

Étape 1 - Configuration d'un rôle système

La première étape que vous devrez suivre est d'autoriser ChallengeMe à communiquer avec Moodle. Cela peut être fait à partir des paramètres du ou des outils LTI 1.1 que vous avez définis précédemment dans votre environnement Moodle.

Pour ce faire, vous devrez vous rendre dans Administration du site, puis cliquer sur Plugins, et cliquer sur Outil Externe (dans Modules d’activité). Vous trouverez ici la configuration de ChallengeMe. Afin de modifier la configuration en place, cliquez sur l'icône d'édition dans le coin supérieur droit de votre configuration.

Dans la configuration de l'outil, vous pouvez maintenant saisir les paramètres personnalisés suivants :

Pour les configurations LTI 1.1 : external_course_id=$Context.id

L'étape suivante de la configuration consiste à créer un nouveau rôle système dans Moodle qui ne reçoit que des autorisations spécifiques qui permettront à ChallengeMe de synchroniser automatiquement les groupes dans Moodle.

Pour configurer le nouveau rôle système, vous pouvez passer par Administration du site, naviguer vers l'onglet Utilisateurs où vous trouverez le module Permissions. Dans ce module, sélectionnez l'option Définition des rôles et cliquez sur Ajouter un nouveau rôle.

Dans la fenêtre qui vient de s'ouvrir, sautez la première étape en cliquant sur le bouton Continuer.

Remplissez l'onglet nom(s) :

Nom court : CM_admin
Nom complet personnalisé : ChallengeMe_admin -Description personnalisée : laisser vide

Pour les types de contexte où ce rôle peut être attribué, veuillez sélectionner l'option "Système".

L'étape suivante consiste à activer l'utilisation de l'API REST en autorisant d'autres autorisations. Pour ce faire, faites défiler la page du rôle et accordez les autorisations suivantes :

webservice/rest:use
moodle/site:viewparticipants
moodle/site:viewuseridentity
moodle/site:accessallgroups
moodle/course:managegroups
moodle/course:view
moodle/course:viewparticipants
moodle/user:viewalldetails
moodle/user:viewhiddendetails
moodle/user:viewdetails
moodle/course:useremail
moodle/course:viewhiddencourses
moodle/course:update
moodle/user:update

Une fois les autorisations accordées, faites défiler la page et cliquez sur Créer un rôle.

Étape 2 - Création d'un nouveau compte utilisateur

Comme le rôle créé doit être lié à Challengeme, vous devez maintenant créer un utilisateur auquel est attribué le rôle que vous venez de créer.

Pour ce faire, allez dans Administration du site, sélectionnez Utilisateurs et dans le module cliquez sur Comptes. Ici, vous aurez la possibilité d'Ajouter un nouvel utilisateur.

Remplissez les champs obligatoires:

nom d’utilisateur: challengeme_admin
nouveau mot de passe: mot de passe de votre choix
prénom: challengeme
nom: admin
adresse de courriel: moodle_admin@challengeme.online
Décocher "Imposer le changement du mot de passe"

. Enregistrez l'utilisateur.

Étape 3 - Associez le nouvel utilisateur au rôle créé

Il est important de noter que l'API Moodle fonctionnera lorsque l'utilisateur créé aura accepté les politiques de cookies et de confidentialité de Moodle.

Pour ce faire, vous pouvez accéder à Administration du site, sélectionner l'onglet Utilisateurs, puis cliquer sur Protection des données et politiques et sélectionner les Accords des utilisateurs. Si les politiques de l'utilisateur ChallengeMe ne sont pas encore acceptées, acceptez-les au nom de l'utilisateur.

Si vous ne pouvez pas accéder à cette page, il vous suffit de vous connecter à la place de l'utilisateur créé et de cocher les cases suivants:

I agree to the Moodle's Privacy Notice
I agree to the Moodle's Cookies Policy

L'étape suivante consiste à ajouter le rôle que vous avez créé à la première étape à l'utilisateur. Pour ce faire, accédez à l'onglet Utilisateurs dans l'Administration du site et sélectionnez la catégorie Permissions. Dans le nouvel onglet, faites défiler jusqu'à l'option Attribuer des rôles système et sélectionnez le rôle que vous avez créé à l'étape 1 pour le nouvel utilisateur créé à l'étape 2.

Étape 4 - Activation des services web

Il vous faut activer les services web dans les fonctionnalités avancées. Cliquer sur Administration du site, puis Fonctions Avancées et puis cliquer sur activer les services web.

Ensuite rendez-vous dans Serveur > Services Web > Gérer les protocoles et activez le protocole “REST protocol”.

Étape 5 - Création d’un service externe

Pour activer l'API Moodle, vous devrez activer la fonctionnalité spécifique que vous souhaitez qu'elle utilise. Pour ce faire, accédez à Administration du site et ouvrez l'onglet Serveur. Faites défiler jusqu'à la catégorie Services Externes. Cliquer sur Ajoutez un nouveau service personnalisé et enregistrez-le avec le nom ChallengeMe. Cocher les cases “activé” et “Uniquement utilisateurs autorisés”.

Dans le nouveau service créé ajoutez les fonctions suivantes en cliquant sur le lien « fonctions » suivi de « Ajouter des fonctions » :

Core_course_get_courses_by_field
Core_course_get_courses
Core_enrol_get_enrolled_users
Core_group_get_course_groupings
Core_group_get_course_groups
Core_group_get_groupings
Core_group_get_group_members
Core_group_get_groups
Core_user_get_users_by_field

Étape 6 - Autorisez votre utilisateur

Accédez à la vue d'ensemble des services externes et cliquez sur Utilisateurs autorisé. Choississez l’utilisateur ChallengeMe admin.

Étape 7 - Créer un jeton de service Web (WST)

Un WST est requis comme méthode d'authentification pour que l'intégration de l'API fonctionne. Pour ce faire, accédez à Administration du site, sélectionnez Serveur et accédez à Services Web. Sélectionnez Gérer les jetons et cliquez sur Créer un jeton**.**

Sélectionnez l'utilisateur et le service externe nouvellement créés et enregistrez.

Vous allez maintenant être redirigé vers la page de présentation des jetons où votre jeton sera affiché.

Intégration de ChallengeMe dans votre LMS

Choix de votre LMS