Ir para YuJa
  1. Central de Ajuda da YuJa
  2. Plataforma de supervisão de provas Verity
  3. Integrações

Integrando a plataforma de supervisão de provas YuJa Verity ao Canvas

Avatar
YuJa
  • Atualizado

Este documento fornece aos administradores instruções para integrar a plataforma de supervisão de provas Verity 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 o 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.

 

Adicionando o Verity ao Canvas

Como administrador, você pode integrar o Verity ao Canvas adicionando um URL JSON às Chaves de desenvolvedor.

  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. Na página Configurações da chave, insira um nome para a sua chave (por exemplo, YuJa Verity).
  5. No menu suspenso Método, selecione Inserir URL.

  6. No campo URL do JSON, insira um dos seguintes URLs, dependendo da sua localização: 

    Zona dos EUA: https://zone1.verity.yuja.com/api/verity/lti/config/canvas.json 

    Zona da Austrália: https://az.verity.yuja.com/api/verity/lti/config/canvas.json 

  7. Clique em Salvar.
  8. Na página Chaves de desenvolvedor, localize a chave do Verity que você adicionou.
  9. Verifique se o botão de alternância do campo Estado está ATIVADO. Se o pop-up Ativar chave de desenvolvedor aparecer, clique em Alterar para ativado. 
  10. Clique em Ver nos aplicativos do Canvas. Uma nova janela do Canvas será aberta.
    toggle and view in canva app.png

  11. Clique em Desbloquear aplicativo.

  12. No pop-up, clique em Desbloquear.

  13. Em seguida, clique no ícone Modificar disponibilidade (lápis). 
  14. Altere o status para Disponível, e clique em Salvar. Prossiga para Gerando um segredo de chave de API para concluir a integração.

Gerando um segredo de chave de API

  1. Clique em + Chave de desenvolvedor > Chave de API.
    API key.png
  2. Insira as seguintes informações:
    • Nome da chave: Verity API Integration
    • URLs de redirecionamento: https://<zoneURL>/api/verity/oauth/callback
      • Zona dos EUA: https://zone1.verity.yuja.com/api/verity/oauth/callback
      • Zona da Austrália: https://az.verity.yuja.com/api/verity/oauth/callback

  3. (Opcional) Ative Impor escopos.
    Observação: Não recomendamos impor escopos. Isso exigirá que você reintegre o Verity à API do Canvas sempre que o Verity adicionar novas funcionalidades que usem a API. Além disso, se os escopos estiverem ativados, o aplicativo Verity Mobile Lockdown não terá suporte. Se a sua instituição usa o aplicativo Verity Mobile Lockdown, é obrigatório que os escopos estejam desativados. 

    Se você não quiser fazer isso, verifique se Impor escopos está desativado e, em seguida, prossiga para a etapa 5. 

  4. Marque Permitir incluir parâmetros e, em seguida, marque os seguintes parâmetros:
    • Contas: 
      • url:GET|/api/v1/accounts
      • url:GET|/api/v1/accounts/:id
      • url:GET|/api/v1/manageable_accounts
      • url:GET|/api/v1/course_creation_accounts
      • url:GET|/api/v1/course_accounts
      • url:GET|/api/v1/accounts/:account_id/sub_accounts
      • url:GET|/api/v1/accounts/:account_id/permissions
      • url:GET|/api/v1/accounts/:account_id/courses
    • Tarefas: 
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:POST|/api/v1/courses/:course_id/assignments
      • 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/accounts/:account_id/courses/:id
      • url:GET|/api/v1/users/:user_id/courses
      • url:GET|/api/v1/courses/:course_id/users
      • url:GET|/api/v1/courses/:course_id/users/:id
    • Ferramentas externas: 
      • url:GET|/api/v1/courses/:course_id/external_tools/:external_tool_id
      • url:GET|/api/v1/courses/:course_id/external_tools
      • url:GET|/api/v1/courses/:course_id/external_tools/sessionless_launch
      • url:GET|/api/v1/accounts/:account_id/external_tools/sessionless_launch
    • Itens do Novo Quiz: 
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items
      • url:POST|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id
    • Quizzes: 
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/courses/:course_id/quizzes/:id
      • url:POST|/api/v1/courses/:course_id/quizzes
      • url:PUT|/api/v1/courses/:course_id/quizzes/:id
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:PUT|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:id/validate_access_code
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
      • url:GET|/api/quiz/v1/courses/:course_id/quizzes
      • url:POST|/api/quiz/v1/courses/:course_id/quizzes
      • url:PATCH|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id
    • Questões de quiz: 
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
      • url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/questions
      • url:PUT|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id
    • Usuários: 
      • url:GET|/api/v1/users/:id
      • url:GET|/api/v1/accounts/:account_id/users

  5. Clique em Salvar no canto inferior direito.

  6. Copie o segredo da chave de API que aparece no pop-up Chave de desenvolvedor criada e, em seguida, clique em Fechar.

  7. Verifique se o botão de alternância Estado da chave de API recém-adicionada está ativado.

  8. Entre em contato com o seu gerente de contas com o segredo da chave de API para finalizar as configurações de LMS para o Verity.

Testando o acesso à API do YuJa Verity

Depois que o seu gerente de contas concluir a integração, você pode testar a API REST para garantir que os instrutores possam excluir quizzes do Verity e criar quizzes de prática do Verity no Canvas.

  1. No Canvas, clique no link YuJa Verity na barra lateral para abrir o portal do Verity.
  2. No Verity, selecione Configurações > Configurações de integração na barra de navegação lateral.
  3. Selecione LMS API no menu suspenso Selecione integração.
  4. Na seção Chaves de acesso, clique em Testar acesso da instituição para verificar se a sua conta do Canvas está integrada à API.
    Os campos Selecione integração e Chaves de acesso estão destacados.
  5. Confirme que o acesso à API foi bem-sucedido tanto para o acesso a Ler contas quanto para o acesso a Ler cursos.
    Observação: Se o acesso à API falhar, entre em contato com o seu gerente de contas para atualizar a chave de API da sua instituição.
  6. Clique em Fechar.
    A janela pop-up Testar acesso à API.

Adicionando o LMS Visualizer ao Canvas

Como administrador, você pode adicionar código JavaScript no Editor de temas para monitorar a extensão do navegador Verity. Com o código JavaScript ativado, os participantes da avaliação serão orientados a baixar a extensão do navegador Verity antes de acessar a avaliação. Eles não conseguirão acessar a avaliação a menos que a extensão do navegador esteja instalada.  

  1. No Canvas, clique no link YuJa Verity na barra lateral para abrir o portal do Verity.
  2. No Verity, selecione Configurações > Configurações de integração na barra de navegação lateral.
  3. Selecione LMS Visualizer no menu suspenso Selecione integração.
  4. Clique em Ver Visualizer.
    O LMS Visualizer está selecionado.
  5. Copie o código JavaScript que aparece na nova guia. 
  6. No Canvas, selecione Temas na barra lateral.
  7. Passe o mouse sobre o seu tema e clique em Abrir no Editor de temas.
    A seção Temas está selecionada na barra lateral do Canvas.
  8. No painel esquerdo, clique na guia Upload.
  9. Localize o campo Arquivo JavaScript do tema, e clique em Ver arquivo para abrir a página do código JavaScript.
    O botão Ver arquivo está destacado.
  10. Clique com o botão direito na página do código JavaScript e selecione Salvar como para salvar o arquivo no seu dispositivo. 
    Salvando o código JavaScript como um novo arquivo.
  11. Abra o arquivo em um editor de texto (por exemplo, o Bloco de Notas) e cole no final o código JavaScript copiado na etapa 5. 
    Adicionando o código JavaScript copiado ao arquivo.
  12. Salve o arquivo no editor de texto. 
  13. No Editor de temas, localize o campo Arquivo JavaScript e clique em Selecionar para enviar o seu arquivo. 
    O botão Selecionar está destacado no campo Arquivo JavaScript.
  14. Localize o campo Arquivo JavaScript do aplicativo móvel do tema, e clique em Ver arquivo para abrir a página do código JavaScript.
    O botão Ver arquivo está destacado no campo Arquivo JavaScript do aplicativo móvel.
  15. Clique com o botão direito na página do código JavaScript e selecione Salvar como para salvar o arquivo no seu dispositivo. 
    Salvando o código JavaScript como um novo arquivo.
  16. Abra o arquivo em um editor de texto (por exemplo, o Bloco de Notas) e cole no final o código JavaScript copiado na etapa 5. 
    Adicionando o código JavaScript copiado ao arquivo.
  17. Salve o arquivo no editor de texto. 
  18. No Editor de temas, localize o campo Arquivo JavaScript do aplicativo móvel e clique em Selecionar para enviar o seu arquivo.
    O botão Selecionar está destacado no campo Arquivo JavaScript do aplicativo móvel.
  19. Clique em Visualizar suas alterações.
    O botão Visualizar suas alterações está destacado.
  20. Clique em Salvar tema.
    O botão Salvar tema está destacado.
  21. Clique em Aplicar tema para adicionar a nova configuração do tema.

Artigos relacionados

Entrar em contato com o suporte