Aller sur YuJa
  1. Centre d'aide YuJa
  2. Plateforme vidéo Lumina
  3. Panneau d'administration
  4. Intégration de la plateforme LMS
  5. Intégration d'Instructure Canvas

Intégration de l'API Instructure Canvas à la plateforme vidéo Lumina

Avatar
YuJa
  • Mise à jour

Ce document explique comment intégrer l'API Canvas Instructure à la plateforme vidéo Lumina. Les administrateurs peuvent intégrer l'API Instructure Canvas et synchroniser automatiquement toutes les informations de Canvas vers Lumina.

Génération de l'ID du client et des clés d'API Canvas

Les instructions ci-dessous permettent aux utilisateurs de générer un nouvel ID du client et une nouvelle clé d'API Canvas pouvant servir à l'intégration à Lumina.

  1. Connectez-vous à Canvas en tant qu'administrateur.

  2. Accédez à l'onglet Admin et choisissez Clés de développeur. Cliquez sur le bouton + Clés de développeur et sélectionnez + Clé d'API.

    Instructure Canvas Guide 1.png

  3. Saisissez les informations comme indiqué ci-dessous, puis cliquez sur Enregistrer.

    Enforces scope.png
  • Nom de la clé : Canvas Auto Sync Key

  • URI de redirection : https://<YOUR_YUJA_DOMAIN>/auth/Canvas

    • Zone États-Unis : https://panorama-api.yuja.com/canvas-auth
    • Zone Canada : https://panorama-api-cz.yuja.com/canvas-auth
    • Zone Europe : https://panorama-api-ez.yuja.com/canvas-auth
    • Zone Australie : https://panorama-api-az.yuja.com/canvas-auth
    • (Facultatif) Activez l'option Appliquer les portées.

    Remarque : Nous ne recommandons pas d'appliquer les portées. Cela vous obligera à réintégrer Panorama à l'API Canvas chaque fois que Panorama ajoute de nouvelles fonctionnalités qui utilisent l'API. Si vous ne souhaitez pas procéder ainsi, veillez à ce que l'option Appliquer les portées soit désactivée.

    Portées recommandées :

    Comptes
    url:GET|/api/v1/accounts
    url:GET|/api/v1/accounts/:id
    url:GET|/api/v1/accounts/:account_id/courses
    url:GET|/api/v1/accounts/:account_id/sub_accounts

    Administrateurs
    url:GET|/api/v1/accounts/:account_id/admins

    Utilisateurs
    url:GET|/api/v1/accounts/:account_id/users
    url:GET|/api/v1/users/:id/profile

    Rôles
    url:GET|/api/v1/accounts/:account_id/roles

    Inscriptions
    url:GET|/api/v1/courses/:course_id/enrollments

    Groupes
    url:GET|/api/v1/courses/:course_id/groups
    url:GET|/api/v1/groups/:group_id/users

    Devoirs
    url:GET|/api/v1/courses/:course_id/assignments
    url:GET|/api/v1/courses/:course_id/assignments/:id

  1. Basculez l'état sur Activé et copiez l'ID du client Canvas pour plus tard.

    Instructure Canvas Guide 3.png

  2. Ensuite, cliquez sur Afficher la clé et copiez la clé d'API Canvas pour plus tard.

    Instructure Canvas Guide 4.png

Intégration de l'API Canvas à la plateforme vidéo

Les étapes suivantes consistent à intégrer la clé d'API Canvas nouvellement obtenue à la plateforme vidéo.

  1. Connectez-vous à la plateforme vidéo en tant qu'administrateur, puis accédez au Panneau d'admin.

    La plateforme vidéo présentant l'option Panneau d'admin dans l'icône du menu principal.
  2. Cliquez sur Intégrations, puis choisissez API LMS dans la liste déroulante Sélectionner une intégration.
  3. Saisissez les informations suivantes, puis cliquez sur Enregistrer.
    • Choisir un LMS : Canvas
    • Lien URL vers votre SGA : https://<YOUR_CANVAS_DOMAIN> (Consultez l'étape 3 de la section précédente pour connaître les zones de domaine.)
    • ID du client : Saisissez l'ID du client Canvas de la section ci-dessus.

    • Secret du client : Saisissez la clé d'API Canvas de la section ci-dessus.

      Instructure Canvas Guide 6.png

  4. Cliquez sur Autoriser l'accès à l'API.

    Instructure Canvas Guide 7.png

  5. Pendant que vous êtes connecté à Canvas en tant qu'administrateur, sélectionnez Autoriser pour permettre à Lumina d'accéder à l'API Canvas.

    Instructure Canvas Guide 8.png

Gestion des appels d'API Canvas

Une fois l'API Canvas configurée, les administrateurs pourront personnaliser les informations à synchroniser de Canvas vers Lumina. En général, nous recommandons aux établissements d'activer tous les paramètres de synchronisation afin de tirer parti de cette fonctionnalité.

  1. Activez les options souhaitées pour que les administrateurs puissent effectuer la synchronisation de Canvas vers Lumina.

    Instructure Canvas Guide 9.png
    • Activer la synchronisation des cours Canvas : Tous les cours du Canvas de votre organisation seront synchronisés avec la plateforme vidéo tous les jours.
    • Activer la synchronisation des utilisateurs de Canvas : Tous les utilisateurs du Canvas de votre organisation qui sont inscrits à un cours Canvas seront synchronisés avec la plateforme vidéo tous les jours. Pour les utilisateurs qui ont deux rôles différents dans Canvas, la plateforme vidéo attribuera le rôle le plus élevé.
    • Activer la synchronisation des inscriptions sur Canvas : Toutes les nouvelles inscriptions d'utilisateurs du Canvas de votre organisation seront synchronisées avec la plateforme vidéo tous les jours.
    • Activer la synchronisation des groupes accommodés de Canvas : Tous les groupes accommodés Canvas du Canvas de votre organisation seront importés dans la plateforme vidéo tous les jours.
    • Activer la synchronisation de sous-compte Canvas : Tous les sous-comptes Canvas associés à votre organisation seront importés dans la plateforme vidéo tous les jours.
    • Démarrer les synchronisations : Synchronisez immédiatement toutes les options activées ci-dessus du Canvas de votre organisation vers la plateforme vidéo.
  2. Cliquez sur Enregistrer les modifications pour appliquer toutes les modifications.

Configuration des notifications d'appels d'API Canvas

Les administrateurs peuvent choisir de configurer un utilisateur pour qu'il reçoive toutes les notifications d'appels d'API Canvas.

  1. Dans la section Notifications, saisissez l'ID d'utilisateur YuJa qui recevra les notifications.

    Instructure Canvas Guide 10.png
  2. Cliquez sur Enregistrer les modifications pour appliquer toutes les modifications.

Configuration des paramètres de liaison de l'API Canvas

Les administrateurs peuvent configurer les paramètres de liaison afin de provisionner les cours et les utilisateurs de Canvas vers Lumina au moyen de l'API Canvas.

Instructure Canvas Guide 11.png

  1. Sous Cours Canvas, cochez la case Utiliser le code du cours et la session comme champs de secours si aucun ID de cours Canvas n'est trouvé.

    Remarque : Pour rechercher uniquement les cours de la plateforme vidéo provisionnés au moyen de LTI, cochez la case Ignorer les cours YuJa non LTI lors de la synchronisation des cours Canvas.

  2. Sous Utilisateurs Canvas, sélectionnez l'Attribut de liaison primaire dans le menu déroulant.

  3. Cochez la case Utiliser le courriel et le nom de l'utilisateur comme champs de secours si aucun ID d'utilisateur Canvas n'est trouvé .

    Remarque : Pour rechercher uniquement les utilisateurs de la plateforme vidéo provisionnés au moyen de LTI, cochez la case Ignorer les utilisateurs de YuJa non LTI lors de la synchronisation des utilisateurs de Canvas.

  4. Cliquez sur Enregistrer les modifications pour appliquer toutes les modifications.

Articles associés

Contacter le support