我该如何在帐户中启用开发人员 API 密钥的范围?

作为创建新开发人员 API 密钥或编辑您帐户中现有开发人员 API 密钥的一部分,您可以自定义 API 密钥接收的访问权限。执行范围允许您控制与您的机构关联的第三方工具的直接访问权限和特定 API 端点。

默认情况下,在创建新的开发人员 API 密钥时禁用范围执行,该密钥允许令牌访问授权用户可用的所有端点。但是,可随时编辑开发人员 API 密钥范围,并适当地更新授权用户的访问令牌。

注意 (Notes):

  • 管理开发人员密钥是帐户权限。如果您无法管理开发人员密钥,则表示您的用户角色尚未启用此权限。
  • 开发人员密钥在子帐户中不可用。

打开帐户

打开帐户

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

打开开发人员密钥

打开开发人员密钥

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

添加开发人员密钥

添加开发人员密钥

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

添加 API 密钥

添加 API 密钥

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

执行范围

执行范围

完成开发人员密钥信息后,点击执行范围 (Enforce Scopes) 按钮。

允许包含参数

允许包含参数

要允许使用此秘钥的所有"包含"参数,请点击允许包含参数 (Allow Include Parameters) 复选框。

"包含"参数可以授予对端点表中未包含的其他数据的访问权限。

搜索端点

搜索端点

要搜索特定端点,请在搜索端点 (Search Endpoints) 栏中键入端点名称 [1]。

要查看所有可用的端点,请滚动端点表 [2]。

选择“只读端点”

选择“只读端点”

要授予对开发人员密钥的只读 (GET) 访问权限,请勾选只读 (Read only) 复选框。此表将自动更新并选择所有包含只读端点的范围。

选择单个端点

您可以授予对开发人员 API 密钥的自定义访问权限。点击任何范围名称以查看可用的端点 [1]。点击端点名称旁边的复选框来选择所需的端点 [2]。范围名称行将更新以显示所选端点访问权限的摘要 [3]。

保存密钥

保存密钥

点击保存 (Save) 按钮。