Como faço chamadas de API em uma conta com um token de acesso?

Se você gerou um token de acesso de API, pode usá-lo para fazer chamadas de API.

Os tokens do Canvas estão alinhados com as permissões do Canvas. Se sua conta do Canvas for excluída ou se você não for mais um administrador, seus tokens também serão revogados.

Opção um: Faça uma chamada por HTTPS


GET /api/v1/courses.json

Todas as chamadas de API também devem ser feitas por HTTPS. O token de acesso deve ser incluído como um parâmetro de consulta de URL em todas as chamadas de API feitas ao Canvas. Por exemplo, o ponto de extremidade para obter a lista de cursos do usuário é:

  • GET /api/v1/courses.json

Para recuperar a lista de Bob, é claro, e se o token de acesso de Bob fosse "token_of_magical_power", você chamaria

  • GET /api/v1/courses.json?access_token=token_of_magical_powers

Para um exemplo detalhado do uso da API, verifique a documentação básica da API no github.

Opção dois: Fazer uma chamada usando um cabeçalho de solicitação

Opção dois: Fazer uma chamada usando um cabeçalho de solicitação

A outra maneira de fazer uma chamada de API com um token de acesso é adicioná-lo ao cabeçalho da solicitação.  Se estiver usando curl (um programa de linha de comando que pode ser usado para executar solicitações de API), você deve especificar o token de acesso como este.  

  • curl -H "Autorização: Bearer <token>" 'http://<canvas>/api/v1/accounts/<account_id>/courses.json'

Observe que o access_token não está na URL.

Veja o exemplo no site de documentação da API.