Skip to main content

LTI 1.3 do Ally para o Canvas

Nota

No Canvas, você pode criar dois tipos de chaves de desenvolvedor: chaves LTI e chaves API. Estas instruções são para chaves do desenvolvedor de LTI. Deseja criar chaves do desenvolvedor da API? Pular para as chaves do desenvolvedor da API do Canvas.

O Ally usa a LTI para realizar a integração com o sistema de gerenciamento de aprendizagem (LMS). A LTI é um padrão desenvolvido pela IMS Global para integrações seguras e perfeitas.

O padrão permite que os usuários acessem o Ally sem sair do Canvas. Esqueça o acesso a múltiplos sites: o LTI permite uma troca segura de informações que proporciona uma experiência coesa para seus usuários.

Existem duas versões da LTI: v1.1 e v1.3. Cada versão requer etapas de configuração diferentes. A versão atual é LTI v1.3. A maior diferença em relação às versões anteriores é o modelo de segurança atualizado baseado em códigos da web OAuth2, OpenID Connect e JSON.

O Ally está migrando para a LTI 1.3 para aproveitar o modelo de segurança atualizado.

O que isso significa para você? Se você for novo no Ally, nada. Realizamos a integração do Ally com você. Mas se o Ally já estiver integrado ao seu LMS, será necessário reconfigurar a integração com a LTI 1.3.

Reconfigure a integração do Ally com a LTI 1.3

Uma instituição típica terá as três ferramentas do Ally a seguir disponíveis na conta original:

Cada ferramenta tem uma chave e um aplicativo de desenvolvedor de LTI correspondentes.

Será necessário configurar cada ferramenta realizando o processo a seguir:

  1. Crie uma chave do desenvolvedor de LTI 1.3 para cada ferramenta.

  2. Configure cada aplicativo de ferramenta com as informações da chave do desenvolvedor.

  3. Envie o código da chave do desenvolvedor e o código de implementação de LTI de cada ferramenta ao Ally para configuração.

  4. Remova a configuração da LTI 1.1.

    Importante

    Realize essa etapa por último para uma transição sem interrupções.

Crie uma chave do desenvolvedor de LTI para cada ferramenta

  1. Acesse a conta raiz da instância do Canvas e em seguida acesse Chaves do desenvolvedor.

  2. Clique no botão + Chave de Desenvolvedor e selecione Chave LTI.

    Página de Chaves de Desenvolvedor em um ambiente Canvas. O botão + Chave de Desenvolvedor é expandido mostrando a opção LTI Chave.

    A tela Configurações de Teclas Configurar se abre.

  3. Clique no menu Método e selecione Colar JSON.

    O menu Método abriu com o Paste JSON aberto destacado.
  4. Abra a URL da ferramenta de LTI para a qual a chave está sendo criada para gerar a configuração JSON. Substitua [AllyEnvironment] pelas informações ambientais em que a sua instituição está hospedada.

    • Relatório Institucional: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/institution

    • Configuração do Cliente: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/config

    • Relatório de Acessibilidade do Curso: https://[AllyEnvironment]/api/v2/auth/lti/1.3/configure/canvas/course

  5. Copie as informações na página da web exibida.

  6. Copie e cole o link a seguir no campo Redirecionar URLs. Substitua [AllyEnvironment] pelas informações ambientais em que a sua instituição está hospedada.

    • https://<AllyEnvironment>/api/v2/auth/lti/1.3/callback</AllyEnvironment>

    alt
  7. Forneça um nome de chave.

    Dica

    Inclua o nome da ferramenta e LTI 1.3 em cada uma. Por exemplo: Relatório da Minha instituição Ally LTI 1.3, Relatório de Acessibilidade de Cursos Ally LTI 1.3 e Configuração do Cliente Ally LTI 1.3.

  8. Clique em Salvar. A nova chave é adicionada à página Chaves do desenvolvedor e está desativada por padrão.

  9. Ative a nova chave.

  10. Copie o número e o segredo do código da chave na coluna Detalhes. Este número de código de chave se for seu código de cliente exclusivo.

Ambiente do Ally para sua região

Use as informações do ambiente do Ally em que sua instituição está hospedada.

  • Centro de dados dos EUA: prod.ally.ac

  • Centro de dados canadense: prod-ca-central-1.ally.ac

  • Centro de dados europeu: prod-eu-central-1.ally.ac

  • Centro de dados de Singapura: prod-ap-southeast-1.ally.ac

  • Centro de dados australiano: prod-ap-southeast-2.ally.ac

Configuração da ferramenta

Siga as etapas a seguir para as ferramentas Relatório Institucional, Configuração do cliente e Relatório de Acessibilidade aos Cursos.

  1. Na conta raiz, selecione Configurações.

  2. Clique em Aplicativos e Ver configurações do aplicativo.

  3. Clique no botão adicionar um Aplicativo.

  4. No menu Tipo de configuração, selecione Por código do cliente.

  5. Cole o número do código da chave do cliente fornecida à equipe de suporte do Ally no campo Código do cliente.

  6. Clique em Enviar.

  7. Clique em Instalar.

  8. Copie o código de implementação de LTI para cada ferramenta de relatório.

Um novo link para a ferramenta é exibido na lista de links de navegação à esquerda. Depois que o Ally configurar a ferramenta no sistema do Ally, será possível acessá-la nesse link.

Envie o código da chave para o Ally

abra um chamado de suporte no Anthology Global Support Center com estas informações para que a equipe do Ally possa configurar as ferramentas no sistema Ally:

  • Código da chave do desenvolvedor de cada ferramenta

  • Código de implementação de LTI de cada ferramenta

  • Solicitação de configuração das ferramentas de LTI 1.3

Por exemplo, a Chave de Desenvolvedor da Minha instituição é: #000000000000000000. Meu código de implementação do Relatório da Minha instituição é: 0000:00c00dc0ec00c00cdc000fced. Configurar meu relatório de LTI1.3.

É possível ter relatórios distintos para as diferentes subcontas no seu ambiente do Canvas. Copie o código de implementação da subconta e adicione essa informação ao chamado de suporte também.

Atualizar o snippet do Ally para o tema do Canvas

Depois que o Relatório Institucional do Ally for configurado com a LTI 1.3, atualize o snippet do Ally no tema do Canvas. É necessário que haja um campo "lti13Id" correspondente ao código do cliente do Relatório Institucional de LTI 1.3 (o código da ferramento Ally) adicionado.

  1. Como administrador do Canvas, acesse Administrador e selecione Conta.

  2. Clique em Temas.

  3. Indique o tema ativo e selecione Abrir no editor de temas.

  4. Clique na guia Upload.

  5. No trecho em Javascript, adicione a propriedade ltil3Id. Substitua o [InstitutionalReportDeveloperChaveID] pelo seu código de Chave de Desenvolvedor do Relatório Institucional.

    window.ALLY_CFG = {
    
    	 'baseUrl': 'https://prod.ally.ac',
    
    	 'clientId': 00000,
    
    	 'lti13Id': '<YourInstitutionalReportDeveloperKeyID>'
    
    	};
    
    	$.getScript(ALLY_CFG.baseUrl + '/integration/canvas/ally.js');
  6. Clique eme Aplicar tema.