Ir para YuJa
  1. Central de Ajuda da YuJa
  2. Plataforma de vídeo Lumina
  3. Painel de administração
  4. Integração com plataformas LMS
  5. Integração com Instructure Canvas

Integrando a API do Canvas Instructure à plataforma de vídeo Lumina

Avatar
YuJa
  • Atualizado

Este documento fornece instruções sobre como integrar a API do Canvas Instructure à plataforma de vídeo Lumina. Os administradores podem integrar a API do Instructure Canvas e sincronizar automaticamente todas as informações do Canvas com o Lumina. 

Gerando o ID do cliente e as chaves de API do Canvas

As instruções abaixo permitirão que os usuários gerem um novo ID do cliente e uma nova chave de API do Canvas que podem ser usados para a integração com o Lumina.

  1. Faça login no Canvas como administrador.

  2. Acesse a guia Administrador e escolha Chaves do desenvolvedor. Clique no botão + Chave do desenvolvedor e selecione + Chave de API.

    Instructure Canvas Guide 1.png

  3. Insira as informações conforme mostrado abaixo e clique em Salvar.

    Enforces scope.png
  • Nome da chave: Canvas Auto Sync Key

  • URIs de redirecionamento: https://<YOUR_YUJA_DOMAIN>/auth/Canvas

    • Zona EUA: https://panorama-api.yuja.com/canvas-auth
    • Zona CAN: https://panorama-api-cz.yuja.com/canvas-auth
    • Zona UE: https://panorama-api-ez.yuja.com/canvas-auth
    • Zona AUS: https://panorama-api-az.yuja.com/canvas-auth
    • (Opcional) Ative Impor escopos.

    Observação: Não recomendamos impor escopos. Isso exigirá que você integre novamente o Panorama à 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 esteja desativado. 

    Escopos recomendados: 

    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

    Usuários
    url:GET|/api/v1/accounts/:account_id/users
    url:GET|/api/v1/users/:id/profile

    Funções
    url:GET|/api/v1/accounts/:account_id/roles

    Matrículas
    url:GET|/api/v1/courses/:course_id/enrollments

    Grupos
    url:GET|/api/v1/courses/:course_id/groups
    url:GET|/api/v1/groups/:group_id/users

    Tarefas
    url:GET|/api/v1/courses/:course_id/assignments
    url:GET|/api/v1/courses/:course_id/assignments/:id

  1. Altere o Estado para Ativado e anote o ID do cliente do Canvas para uso posterior.

    Instructure Canvas Guide 3.png

  2. Em seguida, clique em Mostrar chave e anote a chave de API do Canvas para uso posterior.

    Instructure Canvas Guide 4.png

Integrando a API do Canvas à plataforma de vídeo

As próximas etapas envolvem integrar à plataforma de vídeo a chave de API do Canvas recém-obtida.

  1. Faça login na plataforma de vídeo como administrador, e acesse o Painel de administrador.

    A plataforma de vídeo exibindo a opção Painel de administrador no ícone do Menu principal.
  2. Clique em Integrações, e depois escolha API de LMS na lista suspensa Selecionar integração.
  3. Insira as informações a seguir e clique em Salvar.
    • Escolha um LMS: Canvas
    • Link do URL para o seu LMS: https://<YOUR_CANVAS_DOMAIN> (Consulte a etapa 3 da seção anterior para ver as zonas de domínio.)
    • ID do cliente: Insira o ID do cliente do Canvas obtido na seção acima.

    • Segredo do cliente: Insira a chave de API do Canvas obtida na seção acima.

      Instructure Canvas Guide 6.png

  4. Clique em Permitir acesso à API.

    Instructure Canvas Guide 7.png

  5. Com o login ativo no Canvas como administrador, selecione Autorizar para permitir que o Lumina acesse a API do Canvas.

    Instructure Canvas Guide 8.png

Gerenciando as chamadas da API do Canvas

Com a API do Canvas configurada, os administradores agora poderão personalizar quais informações serão sincronizadas do Canvas com o Lumina. Em geral, recomendamos que as instituições ativem todas as Configurações de sincronização para aproveitar essa funcionalidade.

  1. Ative as opções desejadas para que os administradores sincronizem do Canvas com o Lumina.

    Instructure Canvas Guide 9.png
    • Ativar a sincronização do curso Canvas: Todos os cursos do Canvas da sua organização serão sincronizados com a plataforma de vídeo diariamente.
    • Ativar a sincronização do usuário Canvas: Todos os usuários do Canvas da sua organização que estejam matriculados em um curso do Canvas serão sincronizados com a plataforma de vídeo diariamente. Para usuários que têm duas funções diferentes no Canvas, a plataforma de vídeo provisionará a função de nível mais alto. 
    • Ativar a sincronização da inscrição Canvas: Todas as novas inscrições de usuários do Canvas da sua organização serão sincronizadas com a plataforma de vídeo diariamente.
    • Ativar a sincronização de grupos de acomodação Canvas: Todos os grupos de acomodação do Canvas cadastrados no Canvas da sua organização serão importados para a plataforma de vídeo diariamente.
    • Ativar sincronização da subconta Canvas: Todas as subcontas do Canvas associadas à sua organização serão importadas para a plataforma de vídeo diariamente.
    • Iniciar sincronizações: Sincronize imediatamente todas as opções ativadas acima do Canvas da sua organização com a plataforma de vídeo.
  2. Clique em Salvar alterações para aplicar todas as alterações.

Configurando a notificação de chamadas da API do Canvas 

Os administradores podem configurar um usuário para receber todas as notificações de chamadas da API do Canvas.

  1. Na seção Notificações, insira o ID de usuário do YuJa que deve receber as notificações.

    Instructure Canvas Guide 10.png
  2. Clique em Salvar alterações para aplicar todas as alterações.

Configurando as definições de ligação da API do Canvas

Os administradores podem configurar as definições de ligação para provisionar cursos e usuários do Canvas no Lumina por meio da API do Canvas. 

Instructure Canvas Guide 11.png

  1. Em Cursos do Canvas, marque a caixa Usar código do curso e período como campos de backup se nenhum ID de curso do Canvas for encontrado.

    Observação: Para pesquisar apenas cursos da plataforma de vídeo provisionados via LTI, marque a caixa Ignorar cursos não LTI da YuJa ao sincronizar cursos Canvas.

  2. Em Usuários do Canvas, selecione o Atributo de ligação primária no menu suspenso.

  3. Marque a caixa Usar o e-mail e o nome do usuário como campos de backup se nenhum ID de usuário do Canvas for encontrado . 

    Observação: Para pesquisar apenas usuários da plataforma de vídeo provisionados via LTI, marque a caixa Ignorar usuários não LTI da YuJa ao sincronizar usuários Canvas.

  4. Clique em Salvar alterações para aplicar todas as alterações.

Artigos relacionados

Entrar em contato com o suporte