Serviço de notificação de plataforma com LTI 1.3
O padrão LTI do Serviço de Notificação da Plataforma cria um novo canal para que as ferramentas de aprendizagem externas se comuniquem fora de uma sessão de usuário ativa na Brightspace, aprofundando o nível de integração possível entre as ferramentas de aprendizagem externas e a D2L Brightspace.
Quando ativado, o Serviço de notificação de plataforma permite que ferramentas de aprendizagem externas registrem, atualizem e excluam manipuladores de ferramentas para receber avisos. Quando você ativa o Aviso de cópia de contexto, as ferramentas recebem detalhes de cópia do curso e podem descobrir pontos de extremidade de serviço LTI compatíveis antes que um usuário inicie a ferramenta no curso de destino.
|
Importante: a partir da versão de fevereiro de 2025/20.25.02, a resposta da API do Serviço de notificação da plataforma incluirá o manipulador atualizado apenas na API PUT. As ferramentas LTI que dependem do comportamento anterior, no qual todos os manipuladores eram retornados, podem precisar de atualizações para suportar essa alteração. As integrações existentes funcionam como esperado, mas a automação pode necessitar de ajustes dependendo da resposta da API.
|
Terminais do manipulador para o Serviço de notificação de plataforma
As ferramentas podem registrar os pontos de extremidade do manipulador para tipos de aviso específicos. Em resposta a determinadas ações realizadas no Brightspace, uma carga útil assinada como JWT será publicada no ponto de extremidade registrado contendo dados LTI relevantes para o tipo de aviso fornecido.
Habilitação do serviço de notificação de plataforma
A extensão do Serviço de notificação de plataforma precisa ser habilitada para a integração da ferramenta antes de poder ser usada. O processo de habilitação é semelhante a outras extensões de LTI disponíveis atualmente. Esse novo serviço pode ser ativado por meio de registro dinâmico, APIs ou pela interface do usuário.
Você pode habilitar o Serviço de Notificação de plataforma durante o registro (Gerenciar extensibilidade) e a implantação (Ferramentas de aprendizagem externas). O Aviso de cópia de contexto também deve ser habilitado na implantação da ferramenta. Isso permite que ferramentas de aprendizagem externas subscrevam-se em avisos de eventos webhook.
|
Observação: quando você ativa o Aviso de cópia de contexto, o Brightspace envia detalhes de aviso adicionais para que as ferramentas compatíveis possam descobrir pontos de extremidade do serviço LTI antes da inicialização da ferramenta no curso de destino. Isso pode reduzir os atrasos de configuração após a cópia do curso. |
Para obter mais informações sobre como ativar o Serviço de notificação de plataforma e o Aviso de cópia de contexto no Brightspace durante o registro e a implantação, consulte o tópico Registro da ferramenta, implantação e Links.
APIs de registro e implantação
As APIs de registro e implantação estão disponíveis para criar e atualizar integrações que usam o Serviço de notificação de plataforma. O Serviço de notificação de plataforma precisa estar habilitado no nível de registro e implantação e, em seguida, os tipos de aviso individuais também precisam ser habilitados no nível de implantação.
Registro dinâmico
O Serviço de notificação de plataforma pode ser ativado por meio do registro dinâmico. Os tipos de aviso suportados pela plataforma estão incluídos na solicitação de configuração da plataforma. As ferramentas devem esperar que novos avisos sejam adicionados a essa reivindicação à medida que outros tipos de aviso forem adicionados a esse serviço.
Funcionalidade
Uma vez ativado, o Serviço de notificação de plataforma permite que as ferramentas registrem e atualizem um manipulador para receber avisos.
Os avisos serão enviados para o manipulador registrado de acordo com as definições de aviso específicas descritas abaixo. Cada tipo de aviso deve ter um caso de uso específico.
API do manipulador
O Serviço de notificação de plataforma fornece uma API para permitir que as ferramentas OBTENHAM uma lista de manipuladores que existem atualmente para essa integração e façam atualizações de PUT para esses manipuladores. A API PUT permite que novos manipuladores sejam configurados, que os manipuladores existentes sejam atualizados ou que os manipuladores sejam excluídos. O ponto de extremidade da API é definido no lançamento da LTI sob a reivindicação do Serviço de notificação de plataforma e tem o seguinte formato.
/d2l/api/lti/pns/[version]/handlers/deployment/[DeploymentID]
A seguinte validação ocorre no manipulador registrado. Esses critérios devem ser atendidos antes que um manipulador seja registrado:
- use https
- um URL válido
- Deve estar enraizado no domínio de registro da ferramenta ou corresponder a um URL de redirecionamento registrado.
Avisos suportados
A lista de avisos suportados é mostrada na solicitação de inicialização. A primeira versão do Serviço de notificação de plataforma tem o Aviso de cópia de contexto. Também há um aviso de teste que pode ser disponibilizado mediante solicitação para testar uma integração sem usar eventos específicos do Brightspace.
O aviso de teste é exibido da seguinte forma:
"notice_types_supported":[
0:"LtiContextCopyNotice"
Aviso de cópia de contexto
O Aviso de cópia de contexto informa a ferramenta quando um evento de cópia do curso ocorre dentro das regras de compartilhamento da ferramenta da implantação. O aviso inclui o ID de contexto do curso de origem e o ID do curso de destino. O nome do curso de destino e a sua descrição também serão incluídos se a configuração Segurança das informações da Unidade Organizacional estiver ativada para essa implementação.
O curso de cópia de origem não precisa ser incluído nas regras de compartilhamento da ferramenta para que um aviso seja enviado. Somente o ID do curso de destino precisa estar nas regras de compartilhamento da ferramenta.
Qualquer processo de cópia do curso (por exemplo, manual, em lote ou API) cria um evento de cópia de contexto para enviar à ferramenta.
Descoberta antecipada de ponto de extremidade do serviço
Quando você ativa o Aviso de cópia de contexto, as ferramentas recebem detalhes adicionais que suportam a descoberta de pontos de extremidade do serviço LTI antes que um usuário inicie a ferramenta no curso de destino. Isso permite que os provedores de ferramentas preparem as integrações do serviço com antecedência (por exemplo, validando a disponibilidade do serviço e concluindo as etapas de prontidão) em vez de aguardar até a primeira inicialização no curso copiado.
|
Observação: esse aprimoramento não altera a experiência do usuário do Brightspace. Ele melhora a prontidão da ferramenta enviando informações de descoberta de serviço com antecedência. |
Formato da mensagem
As ferramentas recebem uma carga útil assinada como JSON. Essa carga útil é uma matriz de um ou mais avisos e segue o padrão 1Edtech.
|
Observação: para obter mais informações sobre o padrão 1Edtech, consulte o site da 1EdTech. |
Cada aviso incluirá uma ID e um horário exclusivos. O ID e a hora são específicos do evento de aviso (por exemplo, evento de cópia do curso ou envio) e as informações JSON são exclusivas de quando o aviso está sendo enviado, não relacionadas ao conteúdo do aviso.
Repetir lógica
Não há suporte para novas tentativas na primeira versão desse serviço. No momento, as novas tentativas não são exigidas pelo padrão.
Interrupção de avisos
As seguintes opções estão disponíveis para interromper o envio de avisos para a ferramenta. As três primeiras opções podem ser concluídas por meio do Brightspace ou da API por um administrador:
- Desativar o tipo de aviso específico na implantação
- Desativar o serviço de notificação de plataforma na implantação: desativa todos os tipos de aviso para essa implantação.
- Desativar o serviço de notificação de plataforma no registro: desativa o serviço de notificação de plataforma e todos os tipos de aviso para todas as implantações nesse registro.
- Remover o(s) manipulador(es) de mensagens para essa integração de ferramenta: essa opção só pode ser feita pela ferramenta.
Experiência do usuário
O Serviço de notificação de plataforma é um serviço de plataforma para ferramenta. Esses avisos não são enviados diretamente aos alunos, instrutores ou administradores. Receber essas ferramentas de avisos pode melhorar o nível de serviço fornecido por meio de suas integrações. Ao receber esses avisos, as ferramentas podem melhorar o nível do serviço fornecido por meio de suas integrações. O benefício do Aviso de cópia de contexto é um conteúdo LTI mais confiável após as cópias do curso e a prontidão aprimorada da ferramenta ao permitir a descoberta antecipada do ponto de extremidade do serviço (antes da inicialização da ferramenta no curso de destino), o que pode reduzir os atrasos de configuração para instrutores e administradores.