API Key

1. 简介

1.1 功能简介

API Key，即 API 密钥，是赋予某种形式的秘密令牌的名称，与 Web 服务（或类似的）请求一起提交以识别请求的来源。密钥可以包含在请求内容的某个摘要中，以进一步验证来源并防止篡改这些值。

1.2 使用场景

如在配置前端事件调用部分插件时，需要开启 API 功能后，才能成功配置使用插件。

1.3 预期效果

以自动获取流程状态插件配置中，需要配置简道云 API 后才能开启插件为例。如下所示：

2. 设置步骤

2.1 设置入口

在「开放平台 >> 密钥管理」处，选择「API Key」，即可对 API Key 进行创建、设置等操作。

2.2 创建API

1）点击「创建API Key」，在API 列表中系统会自动创建出成一条 API Key。如下所示：

2）API Key 默认隐藏不显示，点击旁边的小眼睛图标即可显示 API Key 全部内容。

2.3 修改API名称

API Key 生成后，点击生成的 API Key所在行，进入 API Key 信息详情页面，在「名称」处，可以修改 API 名称，以便区分多个 API。

2.4 授权范围

点击 API Key 所在行，进入 API Key 信息详情页面，可对「应用授权范围」和「接口授权范围」进行设置。如下所示：

2.4.1 应用授权范围

应用授权范围支持「全部应用」和「部分应用」两种范围：

2.4.2 接口授权范围

接口授权范围支持「全部接口」和「部分接口」两种范围：

2.5 IP 白名单

设置 IP 白名单后，只有来自白名单范围内的IP地址的请求才会被正常处理，不在白名单内的 IP 地址的请求不会成功。

点击 API Key 所在行，进入 API Key 信息详情页面，在「IP 白名单」处，点击「添加 IP」。如下所示：

在 IP 白名单内，支持设置单个 IP 地址或 IP 地址段。设置 IP 地址段时仅支持带一个 * 号通配符的 IP 格式。如下所示：

2.6 停用/启用

在「状态」处，通过关闭/开启状态开关，对于已经创建的密钥可以进行停用，停用的密钥也可以重新开启使用。

2.7 复制

2.7.1 复制密钥值

在 API Key 的密钥值处，点击复制图标，即可快捷复制密钥值后并进行应用。如下所示：

2.7.2 复制整条API Key

在 API Key 的操作处，点击复制图标，即可复制整条 API Key。复制后，API Key 的授权范围和 IP 白名单会同步复制，但复制后的 API Key 会生成新的密钥值。如下所示：

2.8 删除

对于不需要使用的 API Key 可以进行删除。由于API Key 的重要性，也可以通过删除再新建的方式进行 API Key 的定期更换。