Service de notification de plateforme avec IOA 1.3
Le Service de notification de la plateforme de la Norme IOA crée un nouveau canal permettant aux outils d'apprentissage externes de communiquer en dehors d'une session d'utilisateur active dans Brightspace, ce qui approfondit le niveau d'intégration possible entre les outils d'apprentissage externes et Brightspace D2L.
Lorsqu'il est activé, le Service de notification de la plateforme permet aux outils d'apprentissage externes d'inscrire, de mettre à jour et de supprimer des gestionnaires d'outils pour recevoir des avis et permet qu'un avis de Copie de contexte informe les outils qu'une copie de cours est effectuée.
|
Important : À compter de la version de février 2025/20.25.02, la réponse de l'API du Service de notification de la plateforme inclut uniquement le gestionnaire mis à jour dans l'API PUT. Les outils IOA qui dépendent du comportement précédent, où tous les gestionnaires étaient renvoyés, peuvent nécessiter des mises à niveau pour prendre en charge cette modification. Les intégrations existantes fonctionnent comme prévu, mais l'automatisation peut nécessiter des ajustements, selon la réponse de l'API.
|
Points d’extrémité du gestionnaire pour le Service de notification de la plateforme
Les outils peuvent enregistrer des points d’extrémité du gestionnaire pour des types d'avis spécifiques. En réponse à certaines actions effectuées dans Brightspace, une charge JWT signée s’affichera sur le point d’extrémité enregistré contenant des données IOA pertinentes pour le type d'avis donné.
Activation du Service de notification de la plateforme
L'extension du Service de notification de la plateforme doit être activée pour l'intégration de l'outil avant de pouvoir l'utiliser. Le processus d'activation est le même que celui des autres extensions IOA actuellement offertes. Ce nouveau service peut être activé par l'intermédiaire de l'inscription dynamique, des API ou de l'interface utilisateur.
Vous pouvez activer le Service de notification de la plateforme au moment de l'inscription (Gérer la capacité d'extension) et du déploiement (Outils d'apprentissage externes). L'avis de copie de contexte doit également être activé lors du déploiement de l'outil. Cela permet aux outils d'apprentissage externes de s'abonner aux avis d'événement de point d'ancrage Web.
Pour en savoir plus sur l'activation du Service de notification de la plateforme et l'Avis de copie de contexte dans Brightspace durant l'inscription et le déploiement, reportez-vous à la rubrique Inscription, déploiement et liens de l'outil.
API d'inscription et de déploiement
Les API d'inscription et de déploiement vous permettent de créer et de mettre à jour des intégrations qui utilisent le Service de notification de la plateforme. Le Service de notification de la plateforme doit être activé au niveau de l'inscription et du déploiement, puis les types d'avis individuels doivent également être activés au niveau du déploiement.
Inscription dynamique
Le Service de notification de la plateforme peut être activé lors de l'inscription dynamique. Les types d'avis pris en charge par la plateforme sont inclus dans les allégations de la configuration de la plateforme. Les outils devraient s'attendre à ce que de nouveaux avis soient ajoutés à ces allégations, car d'autres types d'avis sont ajoutés à ce service.
Fonctionnalité
Une fois activé, le Service de notification de la plateforme permet aux outils d'inscrire et de mettre à jour un gestionnaire pour qu’il reçoive des avis.
Les avis seront envoyés au gestionnaire inscrit conformément aux définitions d'avis spécifiques décrites ci-dessous. Chaque type d'avis à une utilisation spécifique.
API du gestionnaire
Le Service de notification de la plateforme fournit une API permettant aux outils d'OBTENIR une liste des gestionnaires existant actuellement pour cette intégration et d’ENVOYER des mises à jour à ces gestionnaires. L'API d’ENVOI permet de configurer de nouveaux gestionnaires, de mettre à jour des gestionnaires existants ou de supprimer des gestionnaires. Le point d'extrémité de l'API est défini dans le lancement de l'IOA sous l’allégation du Service de notification de la plateforme et a le format suivant.
/d2l/api/lti/pns/[version]/handlers/deployment/[DeploymentID]
La validation suivante a lieu pour le gestionnaire enregistré. Ces critères doivent être remplis avant l’inscription d'un gestionnaire :
- utiliser HTTPS
- URL valide
- Doit être ancré dans le domaine d'inscription de l'outil ou correspondre à une URL de renvoi enregistrée.
Avis pris en charge
La liste des avis pris en charge se trouve dans l’allégation du lancement. La première version du Service de notification de la plateforme comprend l'Avis de copie de contexte. Un avis d’essai peut également être offert sur demande pour mettre une intégration à l’essai sans utiliser d'événements spécifiques à Brightspace.
L'avis d'essai s'affiche comme suit :
"notice_types_supported":[
0:"LtiContextCopyNotice"
Avis de copie de contexte
L'Avis de copie de contexte informe l'outil lorsqu'une copie de cours se produit conformément aux règles de partage du déploiement de l'outil. L'avis comprend l'ID de contexte du cours d'origine et l'ID du cours de destination. Le nom du cours de destination et la description du cours sont également inclus si le paramètre Sécurité des renseignements sur l'unité organisationnelle est activé pour ce déploiement.
Le cours copié d’origine n'a pas besoin d'être inclus dans les règles de partage de l'outil pour qu'un avis soit envoyé. Seul l'ID du cours de destination doit figurer dans les règles de partage de l'outil.
Tout processus de copie de cours (manuel, en bloc ou API, par exemple) crée un événement de copie de contexte à envoyer à l'outil.
Format de message
Les outils reçoivent une charge JSON signée. Cette charge est un ensemble d'un ou de plusieurs avis et respecte la norme 1Edtech.
|
Remarque : Pour en savoir plus sur la norme 1Edtech, reportez-vous au site Web de 1Edtech. |
Chaque avis indiquera un identifiant unique et l’heure. L'ID et l'heure sont propres à l'avis (par exemple, Copie de cours ou Soumission); les renseignements JSON sont uniques au moment où l'avis est envoyé, et non ne concernent pas le contenu de l'avis.
Logique de nouvelle tentative
Les nouvelles tentatives ne sont pas prises en charge pour la première version de ce service. Les tentatives ne sont pas actuellement requises par la norme.
Avis d'arrêt
Les options suivantes sont offertes pour mettre fin à l'envoi d'avis à l'outil. Les trois premières options peuvent être effectuées dans Brightspace ou au moyen d’un API par un administrateur :
- Désactivation d’un type d'avis précis lors du déploiement
- Désactiver le Service de notification de la plateforme lors du déploiement : cette option désactive tous les types d'avis pour ce déploiement.
- Désactiver le Service de notification de la plateforme lors de l'inscription : cette option désactive le Service de notification de la plateforme et tous les types d'avis pour tous les déploiements visés par cette inscription.
- Supprimer le ou les gestionnaires de messages pour l'intégration de cet outil : cette option ne peut être effectuée que par l'outil.
Expérience utilisateur
Le Service de notification de la plateforme est un service de plateforme à outil. Ces avis ne concernent pas directement les apprenants, les enseignants et les administrateurs. En recevant ces avis, les outils peuvent améliorer le niveau de service fourni au moyen de leurs intégrations. L’Avis de copie de contexte permet aux apprenants, enseignants et administrateurs d’accéder à du contenu IOA plus fiable après les copies de cours. L'information de copie de contexte permet aux outils de voir les copies de cours effectuées sur la plateforme, ce qui contribue à prévenir les problèmes.