Ir para YuJa
  1. Central de Ajuda da YuJa
  2. Plataforma de acessibilidade para LMS Panorama
  3. Integração com Canvas
  4. Administradores

Integrando o Panorama ao Canvas usando LTI 1.1

Avatar
YuJa
  • Atualizado

Este documento fornece instruções para integrar a plataforma de acessibilidade para LMS Panorama ao seu sistema de gerenciamento de aprendizagem (LMS) Canvas com LTI 1.1. Antes de prosseguir com as etapas abaixo, certifique-se de ter acesso total à sua instância do Canvas como administrador. Se tiver dúvidas sobre qualquer etapa deste processo, entre em contato com o seu gerente de conta dedicado.

 

Obtendo a chave do consumidor, o segredo LTI e o arquivo XML para a sua integração 

Antes de prosseguir com as etapas abaixo, você precisa ter recebido um e-mail do seu gerente de conta pedindo que você crie sua conta do Panorama. Crie sua conta e, em seguida, prossiga com as etapas abaixo. 

  1. Faça login na sua conta do Panorama.
  2. Clique em Configurações no menu do lado esquerdo e, em seguida, selecione Configurações de integração.

  3. Selecione LTI 1.1.

  4. Clique em Baixar XML do LTI 1.1, e copie sua Chave do consumidor e o Segredo LTI. Eles serão necessários na próxima seção deste guia.

Gerando uma chave e um segredo do cliente

  1. Clique em + Chave de desenvolvedor > Chave de API.
    1.png

  2. Insira as seguintes informações:

    • Nome da chave: Panorama API Integration
    • URIs de redirecionamento: https://<zoneURL>/canvas-auth
      • Zona dos EUA: https://panorama-api.yuja.com/canvas-auth
      • Zona do Canadá: https://panorama-api-cz.yuja.com/canvas-auth
      • Zona da UE: https://panorama-api-ez.yuja.com/canvas-auth
      • Zona da Austrália: https://panorama-api-az.yuja.com/canvas-auth

    2.png

  3. (Opcional) Ative Impor escopos.
    Observação: Não recomendamos impor escopos. Isso exigirá que você integre o Panorama novamente à API do Canvas sempre que o Panorama adicionar novas funcionalidades que usem a API. Se você não quiser seguir por esse caminho, certifique-se de que Impor escopos esteja desativado e prossiga para a etapa 5. 
  4. Marque Permitir incluir parâmetros e, em seguida, marque os seguintes parâmetros:
    3.png
    • Contas
      • 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
    • Administradores
      • url:GET|/api/v1/accounts/:account_id/admins
    • Tarefas
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:PUT|/api/v1/courses/:course_id/assignments/:id
    • Cursos
      • url:GET|/api/v1/courses
      • url:GET|/api/v1/courses/:id
      • url:GET|/api/v1/courses/:course_id/users
      • url:GET|/api/v1/courses/:course_id/users/:id
      • url:PUT|/api/v1/courses/:id
      • url:POST|/api/v1/courses/:course_id/files
    • Tópicos de discussão
      • url:GET|/api/v1/courses/:course_id/discussion_topics
      • url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id
      • url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id
    • Matrículas
      • url:GET|/api/v1/users/:user_id/enrollments
      • url:GET|/api/v1/courses/:course_id/enrollments 
    • Períodos de matrícula
      • url:GET|/api/v1/accounts/:account_id/terms
      • url:GET|/api/v1/accounts/:account_id/terms/:id
    • Arquivos
      • url:GET|/api/v1/courses/:course_id/files
      • url:GET|/api/v1/files/:id
      • url:POST|/api/v1/files/:id
      • url:PUT|/api/v1/files/:id
    • Páginas
      • url:GET|/api/v1/courses/:course_id/pages
      • url:GET|/api/v1/courses/:course_id/pages/:url_or_id
      • url:PUT|/api/v1/courses/:course_id/pages/:url_or_id
      • url:POST|/api/v1/courses/:course_id/pages
    • Questionários
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes/:id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes
      • url:PUT|/api/v1/courses/:course_id/quizzes/:id
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
    •  Funções
      • url:GET|/api/v1/accounts/:account_id/roles
      • url:GET|/api/v1/accounts/:account_id/roles/:id
    • Rubricas
      • url:GET|/api/v1/courses/:course_id/rubrics
      • url:GET|/api/v1/courses/:course_id/rubrics/:id
    • Links de recursos LTI
      • url:GET|/api/v1/courses/:course_id/lti_resource_links
      • url:GET|/api/v1/courses/:course_id/lti_resource_links/:id
  5. Clique em Salvar.
    4.png
  6. Localize a chave de desenvolvedor Panorama API Integration recém-criada e copie o ID do cliente em Detalhes.
  7. Clique em Mostrar chave e copie o Segredo do cliente.
  8. Faça login no Panorama e, no menu do lado esquerdo, clique em Configuração > Configurações de integração.
    7.png
  9. No menu suspenso Selecione integração , selecione API do LMS.
  10. Clique em Adicionar chave de acesso.
    9.png
  11. Em Método de autenticação do Canvas, escolha ID do cliente.
  12. No campo ID do cliente , insira o ID da etapa 8.
  13. No campo Segredo do cliente , insira o segredo do cliente da etapa 9.
  14. Se você usou escopos impostos, ative Usar escopos impostos. Caso contrário, ignore esta etapa.
  15. Clique em Autenticar com o Canvas.
    Observação: Certifique-se de estar conectado ao Canvas como administrador com privilégios totais.
  16. Clique em Autorizar.
    13.png
  17. Copie a resposta de autenticação e volte ao Panorama. Cole a resposta no campo Resposta de autenticação do Canvas.
  18. Clique em Adicionar chave de acesso.
  19. Clique em Salvar alterações para concluir a configuração.
    15.png

Adicionando o Panorama ao Canvas

Depois de obter a chave do consumidor, a chave secreta e a configuração XML, você poderá adicionar o Panorama à sua instância do Canvas.

  1. Faça login no Canvas como administrador. Na barra lateral esquerda, clique em Administrador e selecione a conta do Canvas da sua instituição.
  2. Clique em Configurações > Aplicativos > Ver configurações do aplicativo.
  3. Clique em + Aplicativo, preencha as informações a seguir e clique em Enviar para concluir a configuração do Panorama no Canvas.
     
    • Tipo de configuração: Colar XML
    • Nome: Panorama Configuration
    • Chave do consumidor: Obtida na primeira seção deste guia.
    • Chave secreta: O segredo LTI obtido na primeira seção deste guia.
    • Configuração XML: Abra o arquivo XML baixado na primeira seção deste guia. Copie o conteúdo dele em um editor de texto, como o Bloco de Notas, e cole aqui.

Instalando o LMS Visualizer

Esta etapa exige que a sua instância do Canvas tenha o recurso de substituições personalizadas de CSS/JavaScript ativado. Se ele não estiver ativado, entre em contato com o seu gerente de conta do Canvas. O LMS Visualizer permitirá que os ícones de acessibilidade do Panorama sejam exibidos. 

  1. Faça login na sua conta do Panorama.
  2. Clique em Configurações > Configurações de integração.
  3. Selecione LMS Visualizer > Baixar Visualizer.
  4. Em seguida, faça login no Canvas como administrador. Na barra lateral esquerda, clique em Administrador e selecione a conta na qual aplicar o YuJa Panorama - LMS Viewer.
  5. Selecione Configurações na barra de navegação do lado esquerdo e certifique-se de que a guia Configurações esteja selecionada na linha superior.
     
  6. Role a tela para baixo até a seção Recursos.
    • Se a opção Substituições personalizadas de CSS/JavaScript estiver disponível, certifique-se de que esteja marcada. Em seguida, role a tela para baixo e clique em Atualizar configurações.
    • Se a opção Substituições personalizadas de CSS/JavaScript não estiver disponível, entre em contato com o seu gerente de conta do Canvas para ativar as Substituições personalizadas de CSS/JavaScript no Editor de temas.
  7. Em seguida, clique em Temas na barra de navegação do lado esquerdo e escolha o botão + Tema. Selecione qualquer modelo de tema na lista suspensa.
  8. No Editor de temas do Canvas, vá para a guia Upload e selecione o arquivo Canvas Visualizer que você baixou na etapa 3 desta seção. Importante: A guia Upload só fica disponível depois que o seu gerente de conta a ativa.
  9. Em seguida, clique em Visualizar suas alterações, e escolha Aplicar tema. Quando for solicitado que você dê um nome ao tema, digite Panorama Theme.

Desinstalando o Panorama de uma instância do Canvas

Para remover o Panorama de uma instância do Canvas, o administrador precisará remover o aplicativo LTI e o LMS Viewer. Para saber como remover esses recursos, siga as etapas abaixo. 

  1. Faça login no Canvas como administrador. Na barra lateral esquerda, clique em Administrador e selecione a conta do Canvas da sua organização.
  2. Selecione Configurações na barra de navegação do lado esquerdo.
  3. Selecione a guia Aplicativos na linha superior e clique em Ver configuração do aplicativo.
  4. Selecione o ícone de engrenagem do aplicativo LTI do Panorama e clique em Excluir.
  5. Selecione Excluir para confirmar a remoção da ferramenta e desativar a integração do Panorama para LTI 1.1. 
  6. Por fim, como administrador, você precisará remover o LMS Viewer clicando em Temas no menu de navegação.
  7. Em seguida, selecione o tema do Panorama, e clique em Abrir no Editor de temas.
  8. No painel do lado esquerdo, clique em Upload.
  9. Em Arquivo JavaScript, clique no X para remover o script do Panorama.
  10. Clique em Salvar tema. O Panorama foi desinstalado com êxito da instância do Canvas.

Artigos relacionados

Entrar em contato com o suporte