API集

1 概述

1.1 版本

1.2 应用场景

用户需将 API 绑定在「API集」中，用于获取外部系统调用需要输入的鉴权认证，保证发布的 API 接口在被外部系统调用时更安全。

1.3 功能简介

在API与API集绑定的过程中，相同「API集」中的 API 拥有相同的鉴权和访问根路径，用户可在API集中对授权的API进行批量管理。

2 功能入口

点击「数据服务>API集」，可进行API集的管理。如下图所示：

3 功能说明

3.1 创建API集

点击“+”创建API集，如下图所示：

3.2 配置API集

API集创建后自动进入API集配置界面，如下图：

API集配置项说明如下：
1、API集Key
创建API时由系统自动生成，用户可进行修改，确保当前系统内唯一。

2、认证类型
支持三种认证类型：无认证、签名认证和免登认证，具体区别如下：

3、授权系统
选择授权的第三方系统，限制指定第三方系统才能访问该API集中绑定的API。
当认证类型为“签名认证”和“免登认证”时，授权系统必须要配置。授权系统是由系统管理员进行配置的，具体可参考“第三方系统注册”章节说明。

4、url参数、Body参数验证
配置授权系统后，用户可配置url参数和Body参数的验证，参数验证是防止接口访问参数泄露、被篡改和重放攻击。

支持三种参数验证类型：无、签名验证、加密验证，具体区别如下：

注：GET请求方式的API将使用url参数验证方式进行验证；POST请求方式的API将使用Body参数验证方式进行验证。

5、授权API
API 若想被调用必须绑定API集，将使用相同认证控制的API批量添加到该API集中。点击「添加」选择对应的API即可添加到当前API集中，如下图所示：

注：查询API与写入API可被一同绑定。

API添加到API集后将显示API的上线/下线状态以及路径等信息，并支持进行授权有效期、访问频率等配置。

其中，路径中的API集key会自动替换成该API集的key，路径支持复制，复制的是完整访问路径。

1）配置/批量配置：勾选已绑定的 API，点击「批量设置」，可以对 API 的认证方式授权有效期进行设置，同时可设置 API 被访问的频率，如下图所示：

配置项说明如下：

2）解绑/批量解绑：
支持单个解绑或批量解绑，如下图所示：

3.3 导出接口文档

点击“导出接口文档”可导出当前API集对应的API接口文档。文档内容主要包括：应用信息、API集信息、API信息、错误码汇总。

注：API信息中仅导出该API集授权的“已上线”状态的API。