BI RestAPI 数据集插件

1.1 版本

1.2 功能场景

BI Rest API数据集支持FineBI对接WEB API进行取数

• 对接第三方的WEB API进行取数

• 通过JSON解析返回的数据

1.3 注意事项

1）Rest API数据集不支持增量更新的方式。

2）Rest API数据集作为直连数据集时，不支持传递参数到API调用。

2.1 插件安装

• 插件获取：BI Rest API数据集插件

• 设计器插件安装方法参照：设计器插件管理

• 服务器安装插件方法参照：服务器插件管理

插件安装/更新/禁用再启用，需要重启Fine BI后生效

2.2 使用流程

1）安装插件后，公共数据的创建数据集中出现「Rest数据集」选项

2）点击进入创建数据集界面，完成相关配置后，点击保存

3）在数据预览模块，可以预览添加的数据集，该数据集可以用于BI分析中

2.3 面板配置说明

①：数据集名称，可重命名

②：请求类型，支持GET和POST请求方式

③：URL地址，填写接口完整地址即可

URL参数：Query参数会自动拼接到URL地址中

API认证：支持的认证方式：无认证、Basic Auth、Bearer Token、其他认证(自定义Token)

请求头：添加请求头参数

请求体：只有在POST请求方式下，才需要配置Body

               表单方式支持：form-data与x-www-form-urlencoded

               文本方式支持：TEXT、JSON、XML

返回值处理：返回值处理支持JSON解析，通过使用JsonPath语句，查找节点、获取想要的数据

参数设置：支持配置参数，可以在API配置中引用参数（URL、Query参数值、认证参数、Header参数值、Body中均可使用）。

                  引用形式：${参数名}

2.4 全局配置

在「管理系统>系统管理>常规>RestAPI全局配置」中可以进行全局配置，设置日志和连接池相关属性。

当前默认都输出为文本字段。如需修改字段类型，点击如图所示的「编辑」按钮，进行字段类型转换。