1. 概述
1.1 版本
| FineDataLink版本 | 功能变动 |
|---|---|
| 4.0.20.1 | - |
| 4.0.28 | 数据服务支持应用管理功能，支持以应用的方式分组管理API调用方： 支持对「应用」的基础管理功能（新建、编辑、删除、管理权限配置） 支持对「应用」配置鉴权 支持为「应用」授权指定API的访问、指定授权有效期、指定授权调用频率 |
| 4.0.29 | 支持基于AK/SK认证逻辑的摘要签名认证方式 |
| 4.1 | 支持发布API时直接绑定应用 |
| 4.1.6.4 | 可在应用中导出 API 说明文档 |
1.2 应用场景
用户需将 API 绑定在「应用」中，以此获取外部系统调用需要输入的鉴权认证，保证发布的 API 接口在被外部系统调用时更安全。
同时绑定应用后会获取 API 被外部系统调用时读取的 API 和路径地址，应用相当于让多个 API 拥有了被访问的统一父路径。
1.3 功能说明
FineDataLink 支持在创建 API 时和创建后绑定其至对应的应用中，相同应用中的 API 拥有相同的鉴权和访问根路径，也就是通过应用来对发布的 API 进行批量的管理。
每个应用有唯一的 ID（AppId，用于唯一标识应用）和认证信息（AppCode 认证码）。
应用与 API 是多对多的对应关系，同一个 API 可以存在于多个应用中。同一个应用中也可以有多个 API。
2. 前提条件
由于当前发布 API 的Token-APPCode 是直接在请求中传递的，为增强安全性，建议用户使用 HTTPS 部署 FineDataLink。
非超级管理员用户想要使用该功能需要为用户分配 数据服务管理权限、数据服务应用管理权限
3. 方式一：应用绑定已设置好的API
3.1 进入应用列表
点击「数据服务>应用列表」，进入应用创建界面。如下图所示：
3.2 创建应用
点击「新建」创建应用，如下图所示：
3.3 设置应用
3.3.1 设置应用名、应用描述、应用认证方式
进入创建的应用后，设置应用名称、应用描述、应用认证方式。如下图所示：
注：若在应用中设置了应用认证方式 ，则应用下的所有 API 都需要使用该鉴权方式。
设置项说明如下表所示：
| 项目 | 说明 |
|---|---|
| 应用ID | 新建应用时，提示应用ID将在应用保存后自动生成 修改应用时，可以查看当前生效的应用ID |
| 应用名称 | 定义应用名称 必填，默认为空 |
| 应用描述 | 定义应用的详细描述，可为空 |
| 应用认证方式-APPCode | 勾选启用则需要认证 APPCode 可视为长期有效的一种 Token 在访问 API 时，在请求头中指定 Authorization 请求头的值为：APPCode + 空格 + APPCode值 重置按钮在触发重置后，需要检查当前用户是否有权管理应用下所有的 API，如果无权限则报错提示存在已绑定但是无权限的 API，需要有完整的权限才可以重置 权限检查成功后，提示 AppCode 将在应用保存后重新生成，保存后生效，编辑页面未保存则不做重置。（AppKey没有重置功能）
|
| 应用认证方式-摘要签名 | 当应用认证配置为「摘要签名」时，下方会显示 AppSecret ，摘要签名认证方式说明详情参见：摘要签名认证方式 |
3.3.2 绑定 API
点击「绑定 API」添加已经创建好的 API 进入当前应用中，如下图所示：
得到如下效果：
表格中展示应用下所有的API，用户只能对有管理权限的 API 进行设置。
列表展示项目说明：
列表项目 | 说明 |
|---|---|
| API 名称 | 已绑定 API 的名称 |
| API 状态 | 已绑定 API 的状态 |
| API 路径 | 已绑定 API 的访问路径 |
| API 目录 | 已绑定 API 的目录 |
| API 描述 | 已绑定 API 的描述信息 |
API 授权有效期 | 已绑定 API 的授权有效期 有效期内和有效期外需要提供交互侧的区分提示。（如通过有效、无效的标签等方式） |
| API 访问频率 | 已绑定 API 的访问频率限制 |
3.3.3 批量设置/批量解绑
勾选已绑定的 API，点击「批量设置」，可以对 API 的认证方式授权有效期进行设置，同时可设置 API 被访问的频率，如下图所示：
配置项说明如下：
| 项目 | 说明 |
|---|---|
授权有效期 | 若不设置，则 APPCode 或者 AppSecret 长期有效 取消勾选长期有效时，显示时间选框，支持指定有效时间（精确到天） 指定授权有效期后，如果当前时间已超过有效期，则使用此应用无法访问对应 API，需要在编辑绑定 API 的相关页面中，将有效期调整为当前日期之后的值，保存后才能正常访问 |
| 访问频率 | 默认无限制 取消勾选无限制时，限制频率 默认为 100，范围为1~1000000 |
点击保存，即可看到设置好的应用，如下图所示：
4. 方式二：创建API时绑定已设置好的应用
若用户希望在创建 API 时，将 API 直接添加至已经创建的应用中，此时，可以在 API 信息界面，绑定指定的应用，如下图所示：
5. 查看应用
在应用界面，可以及时查看到当前应用的认证方式是否启用、认证、应用ID、已经绑定的 API 等信息，如下图所示：
基本信息说明：
项目 | 说明 |
|---|---|
| 应用ID | 展示应用ID 应用ID是应用的唯一标记，用于和 API 路径一同形成最终可被访问的 URL |
| 应用名称 | 展示应用名称 |
| 描述 | 展示应用的详细描述 |
| 创建人 | 应用的创建人 |
| 创建时间 | 应用的创建时间 |
| 认证方式 | 展示认证方式
|
| 已绑定API | 展示应用下已绑定的 API 列表 包含 API 名称、API 状态、API 路径、API 目录、API 描述、API 授权有效期、API 访问频率 支持直接复制 API 路径 |
6. 导出 API 文档
4.1.6.4 及之后版本，支持导出 API 文档。
6.1 应用场景
API 开发完成后，需要将 API 说明文档提供给调用者，供调用者查看。
6.2 功能说明
如果用户有该应用的管理权限，可以点击「导出API文档」按钮，导出该应用下所有上线API的说明文档，文档格式为 Word 。如下图所示：
在线文档包含的内容如下：
| 展示项 | 说明 |
|---|---|
| 目录树 | 展示目录结构 |
| 应用信息 | 表格形式展示应用信息：
|
| API信息 | 展示该应用下所有上线API的信息
|
| 错误码汇总 | 错误码信息 错误返回内容 |
