管理 API 密钥
API 密钥是唯一的标识符，用于用户、开发人员的身份验证，或用于将程序调用至 API。API 密钥通常用于跟踪和控制界面的使用方式，以防止 API 的滥用。
API 密钥概览
默认设置下，会在 管理控制台 禁用 API 密钥。要启用 API 密钥，转到设置部分。租户管理员可取消 API 密钥，但要编辑 API 密钥设置，要生成或删除 API 密钥，您必须拥有开发人员角色。租户管理员将角色开发人员分配至用户。如果您是租户管理员，则可将开发人员角色分配给自己。
API 密钥表示出了有关 API 密钥的以下信息：名称、ID、所有者、最后更新时间、创建日期、到期日期和状态。使用搜索字段在前三个字段中搜索：密钥名称、密钥 ID 以及所有者。
API 密钥状态
API 密钥可以具有以下状态：
- 激活：API 密钥在使用中。
- 到期：已到达到期日期。
- 已取消：API 密钥已经被取消，无法再使用。
作为管理员，您可审核在 管理控制台 的事件部分中注册的 API 密钥活动。如果检测到可疑活动，诸如大量使用特定 API 密钥，您可撤消该 API 密钥。通过单击表格中右端的箭头打开详细列表，并复制 API 密钥的 ID。然后您可以在 API 密钥部分中搜索 ID，以查找要撤消的 API 密钥。
要撤消 API 密钥，单击右端的按钮 ... 并选择 撤消。您只能撤消状态为激活的密钥。要撤消多个密钥，选择要撤消的密钥左侧的复选框，然后单击右上角的撤消。撤消是不可逆的，无法重新激活已撤消的 API 密钥。
除了重新撤消，还存在删除选项。您可从应用中心删除 API 密钥，而不是在 管理控制台 中。
在租户中启用 API 密钥
设置启用 API 密钥在设置页面上的 管理控制台 中打开。默认设置下，会在 管理控制台 禁用 API 密钥。
| 属性 | 说明 |
|---|---|
| 启用 API 密钥 |
此开关可启用或禁用租户中的所有 API 密钥。只有租户管理员才能启用 API 密钥。 |
| 更改令牌最大到期时间 |
通过更改令牌过期值，所有新令牌都将具有新的过期值。现有的 API 不会受到更改的影响，它们将具有与以前相同的过期值。 该值没有最大限制。 |
| 更改每个用户 API 密钥的最大数目 |
此设置仅影响新 API 密钥。如果新 API 密钥使总数超过最大值，则拒绝创建。 该值的最大限制为 1000。 |
执行以下操作：
- 在 管理控制台 中，转到设置页面。
- 在 API 密钥部分下，打开启用 API 密钥按钮。
- 如果适用，更改更改令牌最大到期时间和更改每个用户 API 密钥的最大数目设置。
正在从应用中心生成 API 密钥
您可从应用中心生成 API 密钥。开始之前，请确保满足以下三个要求：
-
您正在使用许可证。生成 API 密钥需要许可证。
- 设置启用 API 键已在 管理控制台 中打开。
- 租户管理员将角色开发人员分配给了您。
执行以下操作：
-
登录您的租户，例如 https://<tenantname>.com。
-
在右上角单击您的个人资料，并选择个人资料设置。
-
选择 API 密钥。
-
单击生成新密钥。
-
输入 API 密钥描述并选择 API 密钥应当何时过期。
-
单击生成。
即会生成 API 密钥。
-
复制 API 密钥并将其存储在安全位置。
在创建之后，可以编辑 API 密钥的名称。您也可将它删除。