历史版本6 :绑定API至应用 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

FineDataLink 支持将加工、融合后的标准数据，封装发布为规范化API接口数据，供外部系统调用。

在进行数据发布之前，需要首先配置发布环境，也就是设置当前API发布后，外部系统调用需要输入的鉴权认证和开通黑白名单。

以保证发布的 API 接口在被外部系统调用时更安全。

2. 前提条件编辑

由于当前发布 API 的Token-APPCode 是直接在请求中传递的，为增强安全性，建议用户使用HTTPS部署 FineDataLink。

3. 操作步骤编辑

3.1 进入认证配置

点击「数据服务>数据发布>」进入认证配置界面，如下图所示：

3.2 设置认证配置

用户可以设置在当前平台发布的 API 的鉴权认证方式和黑白名单，以保证接口使用的安全性。

进入认证配置界面，比如这里添加鉴权方式 APPCode，自动生成随机APPCode，可以对其进行备注，并启用该APPCode，如下图所示：

相关认证配置说明如下：

配置项
说明
APPCodeAPPCode可视为长期有效的一种Token。

在访问API时，在请求头中指定Authorization请求头的值为：APPCode + 空格 + APPCode值。

  • 服务端对请求头中APPCode进行读取解析，判断APPCode是否有效（APPCode存在、未禁用），有效则通过认证，进行查询处理，返回结果，无效则返回400错误。

  • 默认为空。当没有任何一个APPCode时，如果API配置时开启了认证，则API无法被外部访问，此时API返回400错误。

  • 如果本身API关闭认证，也就是开放API，那么忽略Authorization头传递的内容，传任意值都能正常访问。

然后设置API黑白名单，即当设置后黑白名单指定的IP 或者 IP 段将限制访问 API ，如下图所示：

相关认证配置说明如下：

配置项
说明
黑白名单

  • 不启用

  • 黑名单

  • 白名单

默认选择不启用。

黑名单

黑名单IP列表，黑名单内的IP无法访问API。

  • IP：支持指定IP段和IP地址。

IP段举例：192.168.2.0/24（指定了192.168.2.1~192.168.2.254的地址范围（包含192.168.2.1和192.168.2.254）排除首部的网络地址（192.168.2.0）和尾部的广播地址（192.168.2.255））

IP地址举例：192.168.0.1 

  • 备注：允许为名单项添加备注。

注：在保存设置时，如果黑名单启用，则校验黑名单列表不允许为空。

白名单

白名单IP列表，只有白名单内的IP能访问API，白名单以外的IP均无法访问。

  • IP：支持指定IP段和IP地址。

IP段举例：192.168.2.0/24（指定了192.168.2.1~192.168.2.254的地址范围（包含192.168.2.1和192.168.2.254）排除首部的网络地址（192.168.2.0）和尾部的广播地址（192.168.2.255））

IP地址举例：192.168.0.1 

  • 备注：允许为名单项添加备注。

注：在保存设置时，如果白名单启用，则校验白名单列表不允许为空。

注：建议 APPCode 和黑白名单同时使用，提升接口安全性。

3.3 保存配置

点击保存，对全局的认证配置设置进行保存，如下图所示：

4. 后续步骤编辑

完成认证配置设置后，用户可以进入数据发布进行 API 开发，详情请参见：服务运维