FineBI 通过各种样式如表格、图表等来呈现数据,进行统计分析。
FineBI 是 B/S 架构的纯 Java 软件。
这些数据表格或图表,用户在开发系统的时候也可以自己编程来实现,FineBI也提供了相应的接口。
在Postman中使用 FineBI提供的接口获取数据,这里举几个例子:
| 获取数据集 | get请求 | /v5/api/table/{tableName}/get |
(1)首先在FineBI中导入数据,如下图,导入成绩信息:

(2)postman中请求
浏览器打开F12,在「Network>Headers」下,获取fine_auth_token的值。

http://localhost:37799/webroot/decision/v5/api/table/成绩/get?fine_auth_token=xxx

请求结果如下:(注:该接口只有表头数据,没有成绩数据)

| 获取表数据 | post请求 | /v5/api/tables/{tableName}/fields/page |
(1)首先在FineBI中导入数据,如下图,导入成绩信息:

(2)使用postman
登录FineBi系统,浏览器打开F12,在「Network>Headers」下,获取fine_auth_token的值。如下图所示:

放在请求的queryString中,以?fine_auth_token=token的参数形式拼接到url上,
http://localhost:37799/webroot/decision/v5/api/tables/成绩/fields/page?fine_auth_token=xxx

(3)执行请求,这里会报一个错

提示:request body is missing,那就是没有body
参考官方文档,发现没有此接口的说明:数据表接口 - FineBI帮助文档 (fanruan.com)
查浏览器知,body值为:(除了tableName,其他参数可不写)
- {
- "tableName": "成绩", //必须
- "pageIndex": 1,
- "limit": 5000,
- "keyword": "",
- "taskId": "f93638cac9147eaf"
- }
选择 raw和 json

结果如下:

(4)发现接口不一致
在postman中使用/api路径,发现FineBI在浏览器中使用/conf路径,如下图:

postman中使用conf的路径会报错。
以下为在FineBi在浏览器中使用conf的路径,获取的表数据:

Web页面集成 - FineBI帮助文档 (fanruan.com)
注:直连接口,可在接口URL中,加一个direct即可。
例如添加分组:
抽取接口:/v5/api/group/add
直连接口:/v5/api/direct/group/add
| 分类 | 用途 | 数据接口 |
|---|---|---|
| 数据更新 | 触发全局更新 | /v5/api/conf/update/generate |
| 触发单表/业务包更新 | /v5/api/conf/update/pack/table | |
| 批量更新 | /v5/api/conf/update/batch | |
| 获取此次更新实例的信息 | /v5/api/conf/update/instance/{taskInstanceId} | |
| 数据表 | 添加表 | /v5/api/table/add |
| 修改表转义名 | /v5/api/tables/{tableName}/rename | |
| 分页获取表数据 | /v5/api/tables/data/page | |
| 获取数据集 | /v5/api/table/{tableName}/get | |
| 删除表 | /v5/api/table/{tableName}/delete | |
| 获取表数据 | /v5/api/tables/{tableName}/fields/page | |
| 编辑保存数据集 | /v5/api/table/update | |
| 添加只有选字段步骤的自助数据集 | /v5/api/analysis/table/add | |
| 获取自助数据集的查询SQL | /v5/api/direct/analysis/table/execute/sql/{tableName} | |
| 业务包 | 添加业务包 | /v5/api/pack/{groupId}/add |
| 重命名业务包 | /v5/api/pack/{packId}/rename | |
| 删除业务包 | /v5/api/pack/{packId}/delete | |
| 获取业务包信息 | /v5/api/pack/{packId}/get | |
| 获取业务包中的表信息 | /v5/api/conf/packs/{packId} | |
| 分组 | 添加分组 | /v5/api/group/add |
| 重命名分组 | /v5/api/group/{groupId}/rename | |
| 删除分组 | /v5/api/group/{groupId}/delete | |
| 获取分组信息 | /v5/api/group/{groupId}/get | |
| 获取所有分组业务包信息 | /v5/api/conf/groups |
| 分类 | 用途 | 接口 |
|---|---|---|
| 仪表板编辑 | 新建仪表板 | /v5/api/platform/dashboard/reports |
| 删除仪表板 | /v5/api/platform/dashboard/report | |
| 重命名仪表板 | /v5/api/platform/dashboard/rename | |
| 仪表板另存为 | /v5/api/platform/dashboard/saveas | |
| 创建公共链接 | /v5/api/platform/dashboard/{reportId}/create | |
| 仪表板查看 | 打开仪表板 | /v5/api/dashboard/report/{reportId}/view |
| 仪表板导出Excel | /v5/api/dashboard/report/export/excel | |
| 仪表板导出PDF | /v5/api/dashboard/report/export/pdf | |
| 仪表板导出图片 | /v5/api/dashboard/report/export/png | |
| 仪表板分享 | 取消分享 | /v5/api/dashboard/share/user/rejection/result |
| 分享仪表板给其他用户 | /v5/api/dashboard/share/user/result | |
| 分享给我的所有仪表板 | /v5/api/dashboard/share | |
| 仪表板分享给哪些用户 | /v5/api/dashboard/share/user | |
| 仪表板信息 | 获取用户信息和用户创建的仪表板 | /v5/api/dashboard/user/info |
| 仪表板管理节点所有仪表板信息 | /v5/api/dashboard/search | |
| 获取目录下仪表板和目录列表 | /v5/api/platform/dashboard/list | |
| 获取仪表板信息 | /v5/api/platform/dashboard/reports/info | |
| 获取仪表板组件数据 | /v5/api/dashboard/report/widget/data | |
| 模板血缘分析 | /v5/api/dashboard/report/consanguinity |
| 分类 | 用途 | 接口 |
|---|---|---|
| 页面集成接口 | 仪表板列表页面 | /dashboard |
| 仪表板编辑页面 | /v5/design/report/{reportId}/edit | |
| 仪表板预览页面 | /v5/design/report/{reportId}/view | |
| 数据准备页面 | /v5/api/conf/page | |
| 数据集预览页面 | /v5/api/conf/page#config/{tableName} | |
| 自助数据集编辑页面 | /v5/conf/analysis/page |