1. 概述
FineBI 通过各种样式如表格、图表等来呈现数据，进行统计分析。这些数据表格或图表，用户在开发系统的时候也可以自己编程来实现，但是工作量大，维护难。
因此用户往往选用现成的软件开发，最后将制作好的 FineBI 模板嵌入到自己的系统中，以节省项目开发周期。
用户开发的系统基本上趋于 B/S 架构的浏览器/服务器模式，因此需要将制作好的模板嵌入到系统的某一个页面中，做为页面的一部分。
本章节将详细介绍 Web 页面集成方法。
2. 索引
帮助文档仅提供官方接口，提供给具备自主产品集成能力的用户使用。技术支持不负责接口示例的维护和使用问题解答。
更多接口内容请参见：开放平台BETA
简单集成示例请参见：Web页面简单集成示例
接口调试注意事项请参见：Web页面集成常见问题
2.1 数据接口
注：直连接口，可在接口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/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 |
2.2 仪表板接口
| 分类 | 用途 | 接口 |
|---|---|---|
| 仪表板编辑 | 新建仪表板 | /v5/api/platform/dashboard/reports |
| 删除仪表板 | /v5/api/platform/dashboard/report | |
| 重命名仪表板 | /v5/api/platform/dashboard/rename | |
| 仪表板另存为 | /v5/api/platform/dashboard/saveas | |
| 仪表板查看 | 仪表板导出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/consanguinity |
2.3 集成接口
| 分类 | 用途 | 接口 |
|---|---|---|
| 页面集成接口 | 仪表板列表页面 | /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 |
