Servicio de notificación de plataforma con LTI 1.3
Este estándar LTI del Servicio de notificación de plataforma crea un nuevo canal para que las herramientas externas de aprendizaje se comuniquen fuera de una sesión de usuario activa en Brightspace, profundizando el nivel de integración posible entre las Herramientas externas de aprendizaje y D2L Brightspace.
Cuando está habilitado, el Servicio de notificación de plataforma permite que las herramientas externas de aprendizaje registren, actualicen y eliminen controladores de herramientas para recibir notificaciones y habilita un aviso de Copia de contexto para informar a las herramientas cuando se produce un evento de copia de curso.
|
Importante: A partir de la versión 20.25.02 (febrero de 2025), la respuesta de la API del servicio de notificaciones de la plataforma incluye el controlador actualizado solo en la API de tipo PUT. Es posible que las herramientas LTI que dependían del comportamiento anterior, en el cual se devolvían todos los controladores, necesiten actualizaciones para adaptarse este cambio. Las integraciones existentes funcionan según lo esperado, pero la automatización puede requerir ajustes según la respuesta de la API.
|
Extremos de controladores para el Servicio de notificación de plataforma
Las herramientas pueden registrar extremos de controladores para tipos de aviso específicos. En respuesta a determinadas acciones realizadas en Brightspace, se enviará una carga útil JWT firmada al extremo registrado que contiene datos de LTI relevantes para el tipo de aviso en cuestión.
Habilitación del Servicio de notificación de plataforma
La extensión del Servicio de notificación de plataforma debe estar habilitada para la integración de la herramienta antes de poder usarse. El proceso de habilitación es como otras extensiones de LTI actualmente disponibles. Este nuevo servicio se puede habilitar a través de Registro dinámico, de API o de la interfaz de usuario.
Puede habilitar el Servicio de notificación de plataforma en el registro (Administrar extensibilidad) y la implementación (Herramientas externas de aprendizaje). El Aviso de copia de contexto también debe habilitarse en la implementación de la herramienta. Esto permite que las herramientas externas de aprendizaje se suscriban a los avisos de eventos de Webhook.
Para obtener más información acerca de cómo habilitar el Servicio de notificación de plataforma y el Aviso de copia de contexto en Brightspace durante el registro y la implementación, consulte el tema Registro de herramientas, implementación y enlaces.
API de registro e implementación
Las API de registro e implementación están disponibles para crear y actualizar integraciones que utilizan el Servicio de notificación de plataforma. El Servicio de notificación de plataforma debe habilitarse a nivel de registro y de implementación, y luego los tipos de aviso individuales también deben habilitarse a nivel de implementación.
Registro dinámico
El Servicio de notificación de plataforma se puede habilitar a través de Registro dinámico. Los tipos de aviso admitidos por la plataforma se incluyen en la reclamación de configuración de la plataforma. Las herramientas deben esperar que se añadan nuevos avisos a esta reclamación a medida que se incorporen nuevos tipos de avisos a este servicio.
Funcionalidad
Una vez habilitado, el Servicio de notificación de plataforma permite a las herramientas registrar y actualizar un controlador para recibir avisos.
Los avisos se enviarán al controlador registrado de acuerdo con las definiciones específicas de avisos descritas a continuación. Cada tipo de aviso está destinado a tener un caso de uso específico.
API de controlador
El Servicio de notificación de plataforma proporciona una API que permite a las herramientas OBTENER una lista de controladores que existen actualmente para esa integración y COLOCAR actualizaciones a esos controladores. La API de COLOCAR permite configurar nuevos controladores, actualizar los controladores existentes o eliminar controladores. El extremo de la API se define en el inicio de LTI en la reclamación del Servicio de notificación de la plataforma y tiene el siguiente formato.
/d2l/api/lti/pns/[version]/handlers/deployment/[DeploymentID]
La siguiente validación se produce en el controlador registrado. Estos criterios deben cumplirse antes de que se registre un controlador:
- utilizar https
- una URL válida
- Debe estar anclado en el dominio de registro de la herramienta o coincidir con una URL de redireccionamiento registrada.
Avisos admitidos
La lista de avisos admitidos se muestra en la reclamación de inicio. La primera versión del Servicio de notificación de plataforma tiene el Aviso de copia de contexto. También hay un aviso de prueba que puede estar disponible a pedido para probar una integración sin usar eventos específicos de Brightspace.
El aviso de prueba aparece de la siguiente manera:
"notice_types_supported":[
0:"LtiContextCopyNotice"
Aviso de copia de contexto
El Aviso de copia de contexto informa a la herramienta cuando se produce un evento de copia de curso dentro de las reglas de uso compartido de la herramienta de la implementación. El aviso incluye la ID de contexto del curso de origen y la ID del curso de destino. El nombre del curso de destino y la descripción del curso también se incluyen si el ajuste Seguridad de la información de la unidad de organización está habilitado para esa implantación.
El curso de copia de origen no necesita incluirse en las reglas de uso compartido de la herramienta para enviar un aviso. Solo la ID del curso de destino debe estar en las reglas de uso compartido de la herramienta.
Cualquier proceso de copia de curso (por ejemplo, manual, masivo o API) crea un evento de copia de contexto para enviar a la herramienta.
Formato de mensaje
Las herramientas reciben una carga útil JSON firmada. Esta carga útil es una matriz de uno o más avisos y sigue el estándar 1EdTech.
|
Nota: Para obtener más información sobre el estándar 1EdTech, consulte el sitio web de 1EdTech. |
Cada aviso incluirá una ID y una hora únicas. La ID y la hora son específicas del evento de aviso (por ejemplo, evento de copia del curso o envío), y la información de JSON es exclusiva del momento en que se envía el aviso y no está relacionada con el contenido del aviso.
Lógica de reintento
No se admiten reintentos para la primera versión de este servicio. Actualmente, el estándar no exige reintentos.
Detener avisos
Las siguientes opciones están disponibles para dejar de enviar avisos a la herramienta. Un administrador puede completar las tres primeras opciones a través de Brightspace o mediante API:
- Deshabilite el tipo de aviso específico en la implementación
- Deshabilitar el Servicio de notificación de plataforma en la implementación: esto deshabilita todos los tipos de aviso para esa implementación.
- Deshabilitar el Servicio de notificación de plataforma en el registro: esto deshabilita el Servicio de notificación de plataforma y todos los tipos de avisos para todas las implementaciones en ese registro.
- Quitar los controladores de mensajes para esa integración de herramienta: esta opción solo puede realizarla la herramienta.
Experiencia de usuario
El Servicio de notificación de plataforma es un servicio de plataforma a herramienta. Estos avisos no aparecen directamente a los estudiantes, instructores o administradores. Al recibir estos avisos, las herramientas pueden mejorar el nivel de servicio proporcionado a través de sus integraciones. El beneficio recibido por los estudiantes, instructores y administradores por el Aviso de copia de contexto es un contenido de LTI más confiable después de las copias del curso. La información de Copia de contexto permite a las herramientas tener visibilidad de los eventos de copia de curso en la plataforma, lo que ayuda a prevenir problemas de copia de curso.