Canvas LMS

Saiba mais sobre cada cápsula da coleção Canvas LMS.

Para acessar a coleção Canvas LMS e usar as funcionalidades presentes nesse artigo, você precisa ter a permissão PIPELINE:CREATE. Aprenda mais na documentação sobre Papéis.

Canvas LMS é uma coleção de cápsulas que permite realizar algumas ações em um sistema criado com a plataforma Canvas LMS.

A plataforma Canvas LMS é usada por instituições e organizações educacionais para gerenciar e fornecer cursos e conteúdo educacional para alunos.

Aprenda como funciona cada cápsula da coleção.

Cápsulas Canvas LMS

Access Custom Data

Com a cápsula Access Custom Data da coleção Canvas LMS, você pode pesquisar dados de usuário, criar ou atualizar dados de usuário ou excluir os dados de um usuário de um sistema criado com Canvas LMS. Para mais informações, consulte a seção Users API na API do Canvas LMS.

Dê uma olhada nos parâmetros de configuração da cápsula:

Parâmetro	Descrição	Tipo de dado
Action	A ação a ser tomada. As opções são: Lookup, Create or Update e Delete.	String
Canvas URL	A URL do Canvas LMS.	String
Canvas Account ID	O ID da conta do Canvas LMS.	Inteiro
Canvas User ID	O ID do usuário do Canvas LMS.	Inteiro
Data Namespace	O namespace onde os dados personalizados são armazenados para evitar conflitos.	String
Data Scope	O caminho para a localização dos dados, por exemplo: cores/primário.	String
Data	Os dados a serem armazenados em custom data.	JSON ou Texto
Canvas Auth Token	O token de autenticação da API do Canvas LMS.	String

Tipos de métodos

• Pesquisar por dados do usuário: se você selecionar a opção Lookup no parâmetro Action, uma chamada REST é feita para a API com um método GET e recupera os dados do usuário por meio do ID.

• Criar ou atualizar dados do usuário: se você selecionar a opção Create or Update no parâmetro Action, uma chamada REST é feita para a API com um método PUT.

• Deletar dados do usuário: se você selecionar a opção Delete no parâmetro Action, uma chamada REST é feita para a API com um método DELETE e exclui os dados usuário por meio do ID.

Find/Create User

Com a cápsula Find/Create User da coleção Canvas LMS, você pode buscar, criar, editar ou excluir um usuário de um sistema criado com Canvas LMS. Para obter mais informações, consulte a seção Users API na API do Canvas LMS.

Dê uma olhada nos parâmetros de configuração da cápsula:

Parâmetro	Descrição	Tipo de dado
Action	A ação a ser tomada. As opções são: Get, Create, Edit e Delete.	String
Canvas URL	A URL do Canvas LMS.	String
Canvas Account ID	O ID da conta Canvas LMS.	Inteiro
Canvas Auth Token	O token de autenticação da API Canvas LMS.	String
Payload	O body da solicitação, se necessário.	JSON

Tipos de método

• Buscar usuário: se você selecionar a opção Get no parâmetro Action, uma chamada REST é feita para a API com um método GET para buscar um usuário por meio do ID ou email.

• Criar usuário: se você selecionar a opção Create no parâmetro Action, uma chamada REST é feita à API com um método POST para criar um novo usuário e pseudônimo para uma conta.

• Editar usuário: se você selecionar a opção Edit no parâmetro Action, uma chamada REST é feita à API com um método PUT para editar um usuário existente por meio do ID.

• Deletar usuário: se você selecionar a opção Delete no parâmetro Action, uma chamada REST é feita à API com um método DELETE para excluir o usuário por meio do ID.

SIS Imports

Com a cápsula SIS Imports da coleção Canvas LMS, você pode integrar os Serviços de Informações Estudantis (Student Information Services - SIS) de uma instituição, fornecendo arquivos CSV do Canvas LMS com dados de usuários, cursos e matrículas. Para obter mais informações, consulte a seção SIS Import API na API do Canvas LMS.

Dê uma olhada nos parâmetros de configuração da cápsula:

Parâmetro	Descrição	Tipo de dado
Action	A ação a ser tomada. As opções são: Create import, Get import status, Get import error list, Cancel import, e Cancel all pending imports.	String
Canvas URL	A URL do Canvas LMS.	String
Canvas Account ID	O ID da conta Canvas LMS.	Inteiro
CSV File	O arquivo local a ser atualizado. Aprenda mais sobre o Formato CSV do SIS.	String
Canvas Auth Token	O token de autenticação da API Canvas LMS.	String
Payload	O body da solicitação, se necessário.	JSON

Tipos de métodos

• Criar importação: se você selecionar a opção Create import no parâmetro Action, uma chamada REST é feita para a API com um método POST para importar dados SIS para o Canvas LMS.

• Buscar status da importação: se você selecionar a opção Get import status no parâmetro Action, uma chamada REST é feita para a API com um método GET para buscar o status de uma importação SIS já criada por meio do ID.

• Buscar lista de erros da importação: se você selecionar a opção Get import error list no parâmetro Action, uma chamada REST é feita para a API com um método GET para recuperar a lista de erros de importação do SIS para uma conta ou uma importação do SIS.

• Cancelar importação: se você selecionar a opção Cancel import no parâmetro Action, uma chamada REST é feita para a API com um método PUT para cancelar uma importação SIS que não tenha sido concluída.

• Cancelar todas as importações pendentes: se você selecionar a opção Cancel all pending imports no parâmetro Action, uma chamada REST é feita à API com um método PUT para cancelar importações SIS que já foram criadas, mas não processadas ou que estão em processamento.

Terms

Com a cápsula Terms da coleção Canvas LMS, você pode criar, buscar, editar ou excluir termos de inscrição. Para obter mais informações, consulte a seção Enrollment Terms API na API do Canvas LMS.

Dê uma olhada nos parâmetros de configuração da cápsula:

Parâmetro	Descrição	Tipo de dado
Action	A ação a ser tomada. As opções são: Get, Create, Edit e Delete.	String
Canvas URL	A URL do Canvas LMS.	String
Canvas Account ID	O ID da conta Canvas LMS.	Inteiro
Payload	O body da solicitação, se necessário.	JSON
Canvas Auth Token	O token de autenticação da API Canvas LMS.	String

Tipos de métodos

• Buscar termo: se você selecionar a opção Get no parâmetro Action, uma chamada REST é feita para a API com um método GET para buscar uma lista com os termos de inscrição na conta ou um termo de inscrição específico por meio do ID.

• Criar termo: se você selecionar a opção Create no parâmetro Action, uma chamada REST é feita para a API com um método POST para criar um novo termo de inscrição para a conta especificada.

• Editar termo: se você selecionar a opção Edit no parâmetro Action, uma chamada REST é feita para a API com um método PUT para atualizar um termo de inscrição existente por meio do ID.

• Excluir termo: se você selecionar a opção Delete no parâmetro Action, uma chamada REST é feita à API com um método DELETE para excluir o termo de inscrição por meio do ID.