如何为账户添加开发者 API 密钥？

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

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

关键范围

开发者 API 密钥包含密钥范围控制功能，该功能是在添加开发者 API 密钥时实现的。密钥范围控制允许您控制对第三方工具特定 API 端点的直接访问。

注意：开发者密钥是一项帐户权限。如果您在帐户导航中看不到“开发者密钥”链接，则表示您的用户帐户尚未启用此权限。

开户

在全局导航中，点击管理员链接[1]，然后点击帐户名称[2]。

打开开发者密钥

在“帐户导航”中，单击“开发者密钥”链接。

添加开发者密钥

点击“添加开发者密钥”按钮。

添加 API 密钥

点击“添加 API 密钥”选项。

输入关键设置

请输入开发者 API 密钥的设置：

键名[1]：通常是您的应用或公司名称。当用户被要求代表您授权访问其 Canvas 帐户时，将显示此字段。
所有者电子邮件[2]：开发者工具所有者的电子邮件。
重定向 URI [3]：请求令牌的域名。这些 URI 不是您的 Canvas URL。为避免混合内容浏览器问题，请使用 https。
关联的合作伙伴应用[4]：当您添加重定向 URI 时，Canvas 会检查匹配的合作伙伴应用。
- 如果没有找到匹配项，UTID 字段将保持为空。
- 如果找到匹配项，UTID 将自动填写。
- 如果找到多个匹配项，您可以从下拉菜单中选择正确的合作伙伴应用程序；不会自动选择任何内容。
重定向 URI（旧版） [5]：密钥重定向的 URI。此字段允许您设置工具的先前 URI。此字段最终将被移除。
供应商代码（LTI 2） [6]：用于识别第三方工具的供应商或开发者的唯一注册代码。此代码专门用于 LTI 2 工具和应用程序。
图标 URL [7]：开发者工具图标的 URL。此 URL 会显示给用户，以便他们授权使用您的工具。为避免混合内容浏览器问题，请使用 https。
备注[8]：有关开发者密钥的任何备注，例如创建该密钥的原因。
仅限测试集群[9]：创建一个只能在 Canvas 测试环境中使用的开发者密钥。
客户端凭证受众[10]：选择密钥颁发的凭证是呈现给 Canvas 还是呈现给对等服务。
强制执行范围[11]：允许您自定义密钥的访问权限。否则，该密钥将有权访问授权用户可访问的所有端点。

保存密钥

点击“保存”按钮。

查看图例

查看您账户的开发者密钥。您还可以管理现有的开发者密钥。

Help make the guides even better!

Have a suggestion, spot a typo, or notice something outdated? Sign in and let us know!

Child Item

Canvas LMS 管理员指南

Still have a question about this topic? Ask the Community!

Ask a Question