历史版本5 :开放平台业务场景示例 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 功能简介

目前,很多客户已经基于开放平台,完成了系统集成,并应用到实际业务中,成功解决了业务问题和需求。

本文档详细介绍在实际业务中,如何应用开放平台,与客户的数据中台深度集成,进而充分发挥数据中台的价值。

注:以下介绍内容的前端界面为客户实际开发界面,本文档只介绍接口对接逻辑,不讲解实际系统的开发逻辑,相关效果仅供理解参考。

1.2 预期效果

客户数据中台推出了数据建模,希望通过开放平台,可直接替换 FineBI 数据准备中的原数据模型,只借助 FineBI 中的设计功能去开发报表。


2. 实现示例编辑

2.1 环境准备

安装FineBI,版本要求5.1.18及以上版本

安装FineBI接口子插件

2.2 开放平台配置

1)在平台管理中进入开放平台—应用管理,新建应用

2)点击编辑,获取自动生成的应用ID和密钥

 

3)在权限管理中,开放FineBI接口的权限

注:在后续的接口调用中,均需要在Header参数中添加以下参数

decUser:用户名(需要有BI编辑权限的用户)

client_id:步骤(2)中获取的应用ID

secret:步骤(2)中获取的密钥

2.3 数据中台对接

业务人员在数据中台页面,选择具体的维度和指标信息,如下图所示;

此时页面会根据选择的信息在后台生成对应的sql;开发人员在开发时,需要将sql信息和其他提前准备好的信息,对接如下接口:

1.png

2.3.1 BI新建SQL数据集接口

接口文档地址:https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=6cd43991-55ad-4895-990d-99eefa840ab1

接口URL:

接口URL中的engineName,请根据实际情况填写:engineName:直连-direct;抽取-spider;如下图

具体见:https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=440b0363-08cf-4f09-aa81-8dd5a2a33ef7

Body请求参数:

将步骤(1)中获取的SQL信息,以及已知的文件夹、数据连接信息,通过此接口新建SQL数据集,具体见下图;

实际操作中,开发人员在开发的同时,需要将新建数据集的相关信息保存一遍,用于后续系统进行相关信息的查询和调用

响应:

记录得到数据集名称transfername,该参数将用于后续的仪表板创建

2.3.2 BI仪表板创建接口

接口文档地址:https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=e6215617-603e-4eb0-a17e-5338b598447f

参考1)BI新建SQL数据集接口的步骤,该接口较为复杂,只介绍部分重要参数的情况

Body请求参数:

根据上一步接口的回传信息中的transferName及其他已知信息,创建仪表板,并创建默认组件。参数中的tablename为transfername

响应:
系统在后台创建对应的仪表板及一个默认组件

2.4 进入开发

完成以上的接口对接后,将最后步骤接口返回的仪表板ID,按照固定结构拼接后,即可进入到BI开发页面进行BI的自助分析。

 2.png

3. 总结编辑

目前开发平台整体对接流程清晰,权限设置也比较简便,开发人员在开发页面的时候,可以方便的进行接口的管理和使用。

在对接效果层面,通过接口省略中间步骤,可以让实际业务应用人员拥有更好的交互体验,通过深度集成,可以减弱甚至去除不同系统之间的割裂感。