Web頁面整合API

1.1 版本

1.2 功能简介

FineReport 支持通过 GET 和 POST 两种方式调用接口数据，进行 Web 集成。

本文为你介绍 API 接口相关入门知识，便于后续使用 FineReport 进行 Web 集成。

API接口文档一般分为接口描述、接口地址、请求方法、请求参数、响应内容、错误代码、实例几个部分：

3.1 GET请求

GET通常用于获取服务端数据：

• GET方式在url后面拼接参数，只能以文本的形式传递参数；

• 传递的数据量小，4kb左右（不同浏览器会有差异）；

• 安全性低，会将信息显示在地址栏；

• 速度快，通常用于对安全性要求不高的请求；

• GET请求也可以有Headers参数

GET请求可以传递参数，一般的传递方式为 URL传参。

在GET请求中，遇到参数 / Params / Querys 均是以 URL传参的形式进行传递。

在POSTMAN中，可以直接用 URL传参形式，也可以在Params处填写KEY和VALUE，会自动进行拼接（演示）。

3.2 POST请求

• post提交数据相对于get的安全性高一些。

• 传递数据量大，请求对数据长度没有要求；

• 用于密码等安全性要求高的场合，提交数据量较大的场合，如上传文件，发布文章等。

POST请求一般由Url 、 Headers 、 Body组成，如果在POST请求的接口文档里遇到 Params / Querys 则需以像GET请求一样使用URL参数传递参数，而POST请求的接口文档里面的参数一般指Body。

示例：

除了登录的接口之外，FineReport 所有的WEB API接口，都需要登录才能使用。

1）正式使用：建议配置单点登录，否则嵌入式集成后，需要反复登录。详情请参见：單點登入

2）测试阶段：先登录 FineReport，然后获取token参数，并在调试其他接口时，带上token参数。

本章将讲解两种获取和使用token参数的方法，任选其一即可。

4.1 fine_auth_token

1）用户登录数据决策系统。

2）F12，在「Network>Headers」下，获取fine_auth_token的值。如下图所示：

3）放在请求的queryString中，以?fine_auth_token=token的参数形式拼接到url上。

4.2 Authorization

1）用户登录 FineReport 系统。

2）F12，在「Network>Headers」下，获取Authorization中token的值。如下图所示：

3）放在请求的 header 中，以 key="Authorization"，value="Bearer " + token的形式存放。

注意Bearer后面的空格，建议直接复制上文黄色高亮区域。

作用：使用该接口可以登录数据决策系统。

URL：/login/cross/domain?fine_username=name&fine_password=password&validity=-1&callback=myfunction

请求方式：GET

注：接口参数请参考：前台單點登入API 。

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

1）接口

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

每个接口调用方法为访问：http://ip:端口/工程名/decision/接口调用

2）示例

管理员登录数据决策系统，访问链接：http://localhost:8075/webroot/decision/directory，即可访问目录管理，如下图所示：

注：非管理员身份访问链接，若无目录权限，会出现访问失败的情况，请参考：Web頁面整合常見問題 解决。