Se você for um administrador do Canvas e souber como usar os comandos da interface de programação de aplicativos (API), poderá acessar a API do Catálogo do Canvas para visualizar informações sobre sua conta do Catálogo.
A documentação da API do Canvas Catalog está contida em uma única página, que você pode imprimir ou percorrer. Você também pode acessar automaticamente uma seção da documentação clicando nos links do Sumário.
Você pode gerenciar os administradores de subcatálogos diretamente no produto, incluindo a atribuição ou remoção de acesso administrativo a subcatálogos específicos. Para operações automatizadas ou controladas pelo sistema, a API permite que os desenvolvedores listem os administradores de contas, associem um administrador a uma conta, removam essa associação ou removam o administrador completamente.
Para obter mais informações, visite a documentação da API do Catálogo .
Notas:
- O endpoint da API de Registro de Usuários chega ao fim de sua vida útil, pois todas as funcionalidades de registro são integradas ao endpoint principal de Usuários. Essa transição centraliza o gerenciamento de usuários em uma única interface. A atualização simplifica a arquitetura da API, removendo endpoints redundantes.
- A integração de sistemas consolidados reduz a complexidade da integração ao fornecer um esquema unificado para ações relacionadas ao usuário. Ela simplifica a manutenção a longo prazo para desenvolvedores por meio de uma estrutura de API otimizada e melhora a eficiência ao centralizar as funções de gerenciamento de usuários.
Abra o painel de administração.
Clique no menu suspenso do nome de usuário [1]. Em seguida, clique no link Admin [2].
API aberta
Clique na aba API .
Página de visualização da chave da API
Para usar a página da API, abra e classifique a tabela selecionando qualquer cabeçalho de coluna.
Consulte a tabela de chaves de API, que exibe a descrição da chave de API, o tipo de acesso, o criador, a data de criação, a data de expiração e as informações sobre o último uso.
Abrir nova chave de API
Clique no botão Nova chave de API .
Criar novas chaves de API
Para criar uma nova chave de API, insira uma descrição da chave de API [1]. Para conceder permissões somente leitura, selecione a caixa de seleção Acesso somente leitura [2].
Selecione uma data de expiração usando o seletor de data Data de expiração [3]. A data de expiração é obrigatória e não pode exceder um ano a partir da data de criação da chave.
Clique no botão Enviar para criar a chave [4].
Observação: as chaves de API existentes recebem automaticamente uma data de expiração definida para um ano. Os criadores das chaves recebem e-mails de lembrete 30 e 7 dias antes da expiração. Após a expiração, as chaves não podem ser reativadas e as solicitações feitas com uma chave expirada retornam uma resposta 401 Não Autorizado, exigindo a criação de uma chave de substituição.
Ver documentação da API
Para visualizar a documentação da API, clique no link " Visualizar documentação da API" .
Veja a página de documentação da API
Consulte a página de documentação da API do Catálogo [1] e o índice interativo [2].
Para visualizar o conteúdo, role a página para baixo.
Observação: o Canvas Catalog permite a edição de Campos Definidos pelo Usuário (UDFs) por meio da API após a conclusão do cadastro do aluno. Essa funcionalidade possibilita a atualização de informações como endereços, números de telefone e números de licença, que ficam disponíveis posteriormente durante o ciclo de vida do aluno.
Gerenciar rolagem automática para o conteúdo
Para navegar automaticamente até uma seção na página de documentação e visualizar as subseções, clique no link do nome da seção no sumário.
Curso de API de Certificados de Pesquisa
Identifique o ID do curso Canvas desejado. Inclua o parâmetro `course_id` na solicitação GET da API de Certificados. Execute a chamada para recuperar todos os registros de certificados associados a esse curso específico.
