我该如何在具有访问令牌的帐户中进行 API 调用?

如果您已经生成了 API 访问令牌,,您可以使用它进行 API 调用。

Canvas 令牌与 Canvas 权限保持一致。如果您的 Canvas 帐户被删除,或者您不再是管理员,您的令牌也将被撤销。

选项一:通过 HTTPS 进行调用


GET /api/v1/courses.json

所有 API 调用也必须通过 HTTPS 进行。访问令牌必须作为 URL 查询参数包含在对 Canvas 进行的任何 API 调用中。例如,获取用户课程列表的端点是:

  • GET /api/v1/courses.json

要检索 Bob 的课程列表,并且 Bob 的访问令牌是 "token_of_magical_power",则您可以调用

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

有关使用 API 的详细示例,请查看 github 上的 API 基础知识文档

选项二:使用请求头进行调用

选项二:使用请求头进行调用

使用访问令牌进行 API 调用的另一种方法是将其添加到请求头中。如果使用 curl(一个可用于运行 API 请求的命令行程序),您可以像这样指定访问令牌。

  • curl -H "授权:Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'

请注意,access_token 根本不在 URL 中。

请参阅 API 文档网站上的示例。