1.1 版本

1.2 应用场景

FineBI 是基于 B/S 架构的浏览器/服务器模式，现在用户开发的系统基本上趋向于 B/S 架构的浏览器/服务器模式，因此有些页面完全可以直接采用 Web 页面嵌入式集成的简易方式完成集成。

通过集成，用户从自己的系统通过链接使用浏览器访问 FineBI 的服务器，从而在自己系统内调用 FineBI 的 Web 页面。

1.3 功能简介

集成通常有两种方式：

• 直接使用 URL 链接

• 通过 JS 调用 JSON 来获得分析模板。

本章提供各部分的 URL 链接接口以及 JSON 格式的 API 。

FineBI 在嵌入式集成时一般分为两步：获取 Token 和调用其他相关 API ，详情请参见： Web页面简单集成例子 。

注1：由于平台安全限制，FineBI 在集成时需要将「管理系统>安全管理>安全防护」中的 Security Headers 关闭才可跨域。 

注2：以下接口均支持跨域，且跨域与不跨域的返回值均一致。

更多接口介绍可参见：在线接口文档

2.1 仪表板

2.1.1 仪表板列表

2.1.2 用户信息

使用该接口可以获取当前用户的所有详细信息，目前包括 departs、roles、users、reports，接口为：/v5/api/dashboard/user/info。详情请参见：当前用户所有详细信息

2.1.3 仪表板

2.1.4 分享

2.2 Spider-数据准备

2.2.1 更新

「触发单表或业务包更新接口」不同版本说明：

接口：/v5/api/conf/update/pack/table?info=xx

请求方式：GET

1）业务包更新

请求示例：

localhost:37799/webroot/decision/v5/api/conf/update/pack/table?info={"packageName":"业务包"}

参数说明：

2）单表更新

请求示例：localhost:37799/webroot/decision/v5/api/conf/update/pack/table?info={"packageName":"业务包","tableName":"产品销售表"}

参数说明：

注：fullload 参数为 false 表示增量更新，true 为全量更新，不填改参数默认为 true 。

2.2.2 表

2.2.3 业务包

2.2.4 业务包分组

2.3 决策平台部分

2.3.1 目录管理-仪表板

2.3.2 权限管理-业务包

2.3.3 外观配置

2.3.4 系统管理

2.3.5 智能运维

2.3.6 安全管理

2.3.7 模板认证

2.3.8 定时调度

2.4 BI 接口

2.4.1 业务包

2.4.2 仪表板

2.4.3 分享

很多用户为了统一门户，往往会把 FineBI 的后台管理页面集成到自己的系统中，本章提供 FineBI 支持的页面集成接口。

3.1 示例

以将数据决策系统的「模板管理页面」集成到用户系统为例。

以管理员身份进入数据决策系统，访问链接：http://localhost:37799/webroot/decision/dashboard/management ，如下图所示：

以管理员身份进入数据决策系统，其中每个接口调用方法为访问：http://ip:端口/工程名/decision/接口调用

支持单独页面集成的管理菜单范围如下表所示：

3.2 没有页面访问权限

问题描述：

用户以非管理员身份进入数据决策系统后，访问：http://IP:Port/webroot/decision/接口调用 ，出现如下报错：

解决方案：

需要获得该页面的权限，请参考 分级权限分配

4.1 服务器不支持 JSON 下的 URL

因为 FineBI 中 URL 传递 JSON 对像，若有些服务器不支持 JSON 的 URL ，就需要把 JSON 类型的 URL 参数值先进行编码encodeURIComponent()。

例如：

dir={"name":"新建仪表板12","catalog":[]} 需要改为：
encodeURIComponent(JSON.stringify({"name":"新建仪表板12","catalog":[]}))

编码显示为：

dir=%7B%22name%22%3A%22%E6%96%B0%E5%BB%BA%E4%BB%AA%E8%A1%A8%E6%9D%BF12%22%2C%22catalog%22%3A%5B%5D%7D

4.2 返回错误码

在进行系统集成时，如果后台有错误，会返回错误码（errorCode），具体异常码定义可以参考 系统错误码说明