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.3

Avatar
YuJa
  • Atualizado

Este documento fornece aos administradores instruções para integrar a plataforma de acessibilidade para LMS Panorama ao Canvas usando LTI 1.3. Antes de prosseguir com as etapas abaixo, verifique se você tem acesso total à sua instância do Canvas como administrador. Se tiver dúvidas sobre o processo, entre em contato com seu gerente de contas dedicado.
 

Observação: É altamente recomendável criar uma conta de serviço separada no Canvas para a integração. Isso facilita identificar quais ações foram realizadas pela integração e quais foram realizadas por um administrador humano, ajudando a evitar confusão ou alterações não intencionais.

 

Obtendo sua string JSON do Panorama

Antes de adicionar o Panorama à sua instância do Canvas, você precisará obter sua string JSON. Para acessar sua string JSON, você precisará ter recebido um e-mail do seu gerente de contas pedindo que você se cadastre na sua conta do Panorama. Cadastre-se 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.3.
  4. Clique em Baixar JSON do LTI 1.3 para obter sua string JSON do Panorama. 

Adicionando o Panorama ao Canvas

Depois de obter sua string JSON, você pode 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. Na barra lateral, selecione Administrador > Chaves de desenvolvedor.
  3. Clique em + Chave de desenvolvedor > + Chave LTI.
  4. Em Método (menu suspenso), selecione Colar JSON.
  5. Abra o arquivo JSON baixado na seção anterior em qualquer editor de texto, como o Bloco de Notas, e copie seu conteúdo. As URLs de redirecionamento serão adicionadas automaticamente.
  6. Em seguida, cole o conteúdo copiado no campo Configuração LTI 1.3.

  7. Forneça um Nome da chave de sua escolha e clique em Salvar.

    Observação: Se você quiser que a ferramenta LTI seja desativada por padrão na barra de navegação do curso, adicione o seguinte parâmetro na seção da navegação do curso: "default": "disabled".

    O parâmetro para definir o link LTI do Panorama inserido no código.

  8. Ative a alternância de Estado da chave de desenvolvedor.
  9. Clique em Ver em aplicativos do Canvas. Uma nova janela do Canvas será aberta.
  10. Clique no ícone de lápis.
  11. Altere o status para Disponível, depois clique em Salvar.
  12. Copie o ID do cliente.
  13. Em seguida, selecione Configurações na barra de navegação.
      
  14. Selecione Aplicativos na linha superior e, em seguida, selecione Ver configurações do aplicativo.
  15. Selecione +Aplicativo no canto superior direito da tela.
  16. Em Tipo de configuração, selecione Por ID do cliente.
  17. Cole o ID do cliente copiado anteriormente. Anote-o, pois ele ainda será necessário.
  18. Clique em Enviar para criar o aplicativo.
  19. Selecione o ícone Engrenagem ao lado do aplicativo recém-criado.
  20. No menu suspenso, selecione ID de implementação e copie o ID. Ele será necessário na etapa 24 desta seção.
  21. Em seguida, faça login na sua conta do Panorama.
  22. Clique em Configurações no menu do lado esquerdo e, em seguida, selecione Configurações de integração.
  23. Em Selecione integração (menu suspenso), selecione LTI 1.3.
  24. Insira as informações necessárias de acordo com seu ambiente do Panorama (tipo de conta): 
    1. Ambiente de produção: 
      1. ID do cliente: O ID do cliente copiado na etapa 12. 
      2. ID de implementação: O ID de implementação copiado na etapa 20. 
      3. ISS: https://canvas.instructure.com
      4. Endpoint OIDC: https://canvas.instructure.com/api/lti/authorize_redirect
      5. Endpoint JWKS: https://canvas.instructure.com/api/lti/security/jwks
         
    2. Ambiente de teste:
      1. ID do cliente: O ID do cliente copiado na etapa 12. 
      2. ID de implementação: O ID de implementação copiado na etapa 20. 
      3. ISS: https://canvas.test.instructure.com
      4. Endpoint OIDC: https://canvas.test.instructure.com/api/lti/authorize_redirect
      5. Endpoint JWKS: https://canvas.test.instructure.com/api/lti/security/jwks
         
    3. Ambiente beta:
      1. ID do cliente: O ID do cliente copiado na etapa 12. 
      2. ID de implementação: O ID de implementação copiado na etapa 20. 
      3. ISS: https://canvas.beta.instructure.com
      4. Endpoint OIDC: https://canvas.beta.instructure.com/api/lti/authorize_redirect
      5. Endpoint JWKS: https://canvas.beta.instructure.com/api/lti/security/jwks
  25. Clique em Salvar alterações para adicionar o Panorama à sua instância do Canvas e, em seguida, prossiga para a 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
    • URLs 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 prosseguir com isso, certifique-se de que Impor escopos está desativado e, em seguida, prossiga para a etapa 5. 
  4. Marque Permitir parâmetros de inclusão 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. Em Selecione integração (menu suspenso), selecione API de LMS.
  10. Clique em Adicionar chave de acesso.
    9.png
  11. Para o método de autenticação do Canvas, escolha ID do cliente.
  12. Em ID do cliente (campo), insira o ID da etapa 8.
  13. Em Segredo do cliente (campo), 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: Verifique se você está conectado ao Canvas como administrador com todos os privilégios.
  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

Instalando o LMS Visualizer 

A instalação do LMS Visualizer permitirá que os ícones do Panorama apareçam nos cursos. Esta etapa exige que 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 seu gerente de contas do Canvas.

  1. Faça login no Panorama.
  2. Clique em Configurações no menu do lado esquerdo e, em seguida, selecione Configurações de integração.
  3. Em Selecione integração (menu suspenso), escolha LMS Visualizer e clique em 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 verifique se a guia de configurações está selecionada na linha superior. 
  6. Em seguida, clique em Temas na barra de navegação do lado esquerdo e depois no botão + Tema. Selecione qualquer modelo de tema no menu suspenso.

  7. No editor de temas, acesse a guia Carregar e selecione o arquivo Visualizer que foi baixado. 

    Observação: A guia Carregar só fica disponível depois que seu gerente de contas do Canvas a ativa.

  8. 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.

Artigos relacionados

Entrar em contato com o suporte