Como faço para criar uma integração de dados automatizada para uma conta com Canvas e meu SIS?

[#1]

As importações do Sistema de Informações do Aluno (SIS) são uma ótima maneira de importar manualmente dados em massa (ou alterações) para o sistema Canvas. Esta lição fornecerá as lições básicas sobre como usar a API Canvas e a linguagem de programação de sua escolha para configurar um sistema automatizado para gerenciar seu fluxo de trabalho de importação do SIS.

Várias linguagens de programação podem ser usadas para construir uma ferramenta de integração automatizada com o Canvas. Se sua linguagem de programação preferida pode fazer chamadas da web (HTTPS) Secure Socket Layer (SSL) para um servidor externo e tem a capacidade de postar arquivos, você pode aplicar as etapas desta lição para a linguagem de programação de sua escolha (ou apenas instalar cURL e escrever um arquivo em lote). Esta lição fornece uma abordagem simples para configurar um sistema básico de importação automatizado. No entanto, você pode querer desenvolver um sistema mais complexo baseado em suas habilidades e nas habilidades de sua integração SIS específica.

Teste de integração de dados

Para evitar afetar os dados em seu ambiente de produção, você pode querer configurar sua integração SIS em seu ambiente de teste para testes precisos. A cada três semanas, um dia após um novo lançamento de produção do Canvas, seu ambiente de produção criará uma cópia atualizada para seu ambiente de teste para que você possa testar com dados atualizados. Depois de confirmar que seus dados funcionam corretamente, você pode reaplicar a integração do SIS ao ambiente de produção.

Como alternativa, você pode criar suas alterações em seu ambiente de produção e, em seguida, aguardar a próxima atualização antes de começar a praticar em seu ambiente de teste.

Ajuda avançada

• Grupo de migrações e integrações da comunidade do Canvas
• Documentação da API Canvas
• Importações do SIS via API do Canvas (automatizado)
• Importações do SIS via UI do Canvas (manual)

Abrir Conta

Clique no link Admin [1], depois clique no nome da conta [2].

Abrir permissões

Em Navegação da Conta (Account Navigation), clique no link Permissões (Permissions).

Modificar função do usuário e permissões

Na guia Funções da Conta, crie uma função do usuário no nível da conta e permita que o usuário gerencie os dados do SIS. Se não quiser criar uma nova função de usuário, você pode usar uma função de usuário existente e modificar as permissões.

Adicionar novo usuário manualmente

Você precisará adicionar manualmente um novo usuário para gerenciar os dados do SIS. Você pode usar um usuário existente importado via SIS, mas criar manualmente um novo usuário é benéfico para fins de segurança. Esse novo usuário terá apenas uma permissão, mas essa permissão concede a capacidade de criar, modificar e excluir muitos tipos de objetos no Canvas.

Adicionar usuário como administrador

Para habilitar as permissões do SIS, adicione seu administrador como um usuário administrativo à sua conta. Defina o usuário com a função de usuário em que ativou a permissão de dados SIS.

Obter o token de acesso da API

Saia do Canvas e faça login novamente como o novo usuário. Em Configurações do Usuário em Integrações Aprovadas, adicione um novo token de acesso. Deixe a data de expiração em branco, a menos que você tenha um motivo para especificar uma data. Aprenda como obter um token de acesso de API.

Nota: Certifique-se de salvar este token de acesso da API em um local seguro. Um token de acesso à API é efetivamente o mesmo que um nome de usuário e uma senha, portanto, trate-o com segurança semelhante. Lembre-se de que o token criado em seu ambiente de teste será substituído pelo token criado em seu ambiente de produção durante o próximo período de atualização do ambiente de teste.

Importar dados via API

curl -H "Autorização: Portador <api_token>" 'https://<canvas_fqdn>/api/v1/accounts/self/sis_imports/<import_id>'

Pratique a importação de dados por meio da API. Um método de API é usar cURL, uma ferramenta de linha de comando para transferir dados com suporte em todos os sistemas operacionais (Windows, Linux e OSX). A API pode mostrar como praticar a importação de um arquivo de teste e verificar o status de uma importação anterior.

Saiba mais sobre como usar a API para importar dados para o Canvas.

Criar script de importação

Usando sua linguagem de programação preferida, crie um script SIS. Um script SIS sincroniza automaticamente os usuários em sua instituição com sua conta do Canvas. Visualizar o fluxograma do script SIS.

O script de importação pode ser tão simples ou complexo quanto sua instituição exigir. Além disso, uma variedade de linguagens de programação pode ser usada para escrever seu script/programa de importação.

Saiba mais sobre como criar um script SIS do Canvas.

Exportar dados e criar arquivo CSV do Canvas

Exporte seus dados SIS em um formato de arquivo CSV do Canvas. Coloque o(s) arquivo(s) em um diretório ou pasta que contenha apenas arquivos CSV prontos para serem importados. Dependendo do seu SIS, esta etapa pode ser automatizada. Para obter mais informações sobre integração, entre em contato com o gerente de sucesso do cliente do Canvas.

Exportações do SIS

Devido às grandes variações entre os Sistemas de Informação do Aluno (SIS), esta lição não pode documentar um método completo para exportar dados. No entanto, aqui estão alguns métodos possíveis de acesso a dados que podem estar disponíveis para você:

• Acesso à API: O SIS pode fornecer uma API de alguma forma que permitirá a você coletar dados.
• Dados diretos (acesso ao banco de dados): O SIS pode permitir o acesso direto ao banco de dados (ou outros dados diretos) aos seus dados do SIS.
• Geração de relatório ou exportação de dados: O SIS pode ter a capacidade de executar relatórios ou exportar dados e recebê-los por e-mail, de um site/programa da web ou salvos em uma pasta.
• Eventos de gatilho ou rastreamento: O SIS pode ter a capacidade de executar trabalhos em um evento acionado. Esse tipo de rastreamento pode ser mais adequado para a manipulação direta da API de objetos Canvas, mas você pode ter um script/programa que coleta as alterações acionadas para atualizações em lote em intervalos frequentes usando importações do SIS.

Depois de saber como acessar seus dados SIS, um script/programa pode ser escrito e usado para manipular e filtrar os dados para corresponder ao formato necessário para importações do SIS do CSV. Em alguns casos, pode ser necessário executar esta etapa manualmente. Você precisará trabalhar com sua equipe administrativa ou fornecedor do SIS para descobrir a melhor maneira de exportar dados.

Nota: Ao trabalhar com sua equipe do SIS, certifique-se de fornecer a documentação do formato de arquivo Canvas CSV, que pode reduzir a complexidade ou eliminar a necessidade de um script/programa para preparar os dados antes da importação.