我该如何为帐户添加开发人员 API 密钥?

作为管理员,您可以创建根帐户的开发人员 API 密钥。开发人员 API 密钥是提供给第三方应用程序开发人员的代码,允许访问 Canvas 中的某些信息和权限。开发人员 API 密钥可用于创建与 Canvas 的自定义集成,并允许第三方应用程序使用 Canvas 身份验证。开发人员 API 密钥使用 Oauth2,使应用程序能够使用 Canvas 进行身份验证。有关 Oauth2 的更多信息,请参阅 Instructione API Oauth 文档。

当用户请求访问时,开发人员 API 密钥从应用程序发送到 Canvas。应用程序向用户请求以编程方式创建 API 访问令牌的权限。当用户授权应用程序时,第三方应用程序将具有与授予访问权限的用户相同的信息访问权限和帐户权限。有关开发人员文档的更多信息,请参阅 Instructure Github 页面

秘钥范围 (Key Scoping)

开发人员 API 密钥包含密钥范围功能,作为添加开发人员 API 密钥的一部分。利用密钥范围,您可以控制对第三方工具的特定 API 端点的直接访问。

注意:开发人员密钥是帐户权限。如果您在帐户导航 (Account Navigation) 中看不到开发人员密钥 (Developer Keys) 链接,则表示您的用户帐户尚未启用该权限。

打开帐户

打开帐户

在全局导航,点击管理员 (Admin) 链接 [1],然后点击帐户名称 [2]。

打开开发人员密钥

打开开发人员密钥

在帐户导航 (Account Navigation) 中,点击开发人员密钥 (Developer Keys) 链接。

添加开发人员密钥

添加开发人员密钥

点击开发人员密钥 (Add Developer Key) 按钮。

添加 API 密钥

添加 API 密钥

点击添加 API 密钥 (Add API Key) 选项。

输入密钥设置

输入开发人员 API 秘钥的设置:

  • 秘钥名称 (Key Name) [1]:通常是您的应用程序或公司名称。当用户被要求以您的名义批准对其 Canvas 帐户的访问时,将显示此字段。
  • 所有者电子邮箱 [2]:开发人员工具所有者的电子邮箱。
  • 重定向 URIs (Redirect URIs) [3]:请求令牌的域。这些 URI 不是您的 Canvas URL。为避免混合内容浏览器问题,请使用 https。
  • 重定向 URI(旧版)(Redirect URI (Legacy)) [4]:密钥重定向用 URI。此字段允许您为工具设置以前的 URI。此字段最终将被删除。
  • 供应商代码 (Vendor Code) (LTI 2) [5]:标识第三方工具的供应商或开发人员用的唯一注册代码。这专门面向 LTI 2 工具和应用程序。
  • Icon URL [6]:开发人员工具的图标 URL。此 URL 将显示给用户以批准您的工具的授权。为避免混合内容浏览器问题,请使用 https。
  • 注意 [7]:关于开发人员密钥的任何注释,例如创建该密钥的原因。
  • 仅测试群集 (Test Cluster Only) [8]:创建只能在 Canvas 测试环境中使用的开发人员密钥。
  • 执行范围 (Enforce Scopes) [9]:允许您自定义密钥的访问权限。否则,密钥将有权访问授权用户可用的所有端点。

保存密钥

保存密钥

点击保存 (Save) 按钮。

查看密钥

查看您的帐户的开发人员密钥。