【仅供内部供应商使用,不提供对外解答和培训】

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

获取data结果:

2.2.3 报表结果JSON服务API(新版)

新版接口接口调用支持跨域请求调用。

URL地址

http://ip:port/webroot/decision/api/report

METHOD

POST

Content-Type

application/json

RAW

{
    "report_path": "tabledataService/Parameter_3.cpt",
    "start_page": 1,
    "end_page": 1,
    "timestamp": "123456789",
    "sign": "468705dc60eff5f67438f9b94ed15245",
    "parameters": [
        {
            "name": "产品类型",
            "type": "String",
            "value": "饮料"
        },
        {
            "name": "地区",
            "type": "String",
            "value": "华北"
        }
    ]
}

Response响应

{
    "err_code": 0,
    "err_msg": "",
    "start_page": 1,
    "end_page": 1,
    "total_page_number": 1,
    "data": [
        {
            "A1": "华北销售额",
            "A2": "地区"
        }
    ]
}

...

URL地址

http://ip:port/webroot/decision/url/api/report

METHOD

POST

Content-Type

application/json

RAW

{

    "report_path": "Parameter_3.cpt",

    "start_page": 1,

    "end_page": 1,

    "timestamp": "123456789",

    "sign": "468705dc60eff5f67438f9b94ed15245",

    "parameters": [{

           "name": "地区",

           "type": "String",

           "value": "华北"

       },

       {

           "name": "产品类型",

           "type": "String",

           "value": "饮料"

       }

    ]

}

Response响应

{

    "err_code": 0,

    "err_msg": "",

    "start_page": 1,

    "end_page": 1,

    "total_page_number": 1,

    "data": [

       [{

           "A1": "华北销售额","A2": "地区"

       }]

    ]

}

参数说明:

  • report_path:报表模板路径名称(必须项),例如 doc/Parameter_3.cpt。
  • start_page:报表内容起始页码(必须项);
  • end_page:报表内容结束页码(必须项);
  • parameters:报表面板参数(可选);参数名对应模板参数空间名称;
  • timestamp:当前时间的毫秒数(用于签名认证,可选);
  • sign:安全签名(用于签名认证,可选);

 响应说明:

...

参数说明、 响应说明、参数JSON转换规则,可参考2.2.3对应部分说明。

 报表结果JSON示例:

访问报表Parameter_3.cpt的数据集内容。

参数JSON转换规则

...

参数类型

...

类型值

...

示例

...

字符串

...

String

...

{"name":"aa","type":"String","value":""}

...

整型

...

Integer

...

{"name":"aa","type":"Integer","value":""}

...

双精度型

...

Double

...

{"name":"aa","type":"Double","value":""}

...

日期

...

Date

...

{"name":"aa","type":"Date","value":""}

...

布尔型

...

Boolean

...

{"name":"aa","type":"Boolean","value":""}

...

公式

...

Formula

...

{"name":"aa","type":"Formula","value":""}

 

安全签名配置

2.2.5 调用接口管控

安全签名配置

安全签名用于控制接口调用的权限验证。

报表平台管理页面(数据决策系统)-》管理系统-》系统管理-》点击‘常规’选项卡,配置‘JSON服务接口插件’的秘钥内容。如图

Image RemovedImage Added

安全签名的计算规则为 MD5(秘钥code+report_path+timestamp),默认秘钥为空,不验证。
如配置了秘钥,系统会依规则计算MD5值与sign比较,相同即符合。
 

国密认证

国密认证用于对接口返回的 data,进行加密处理,避免信息泄露。

在插件参数页面的 启用国密认证 ,维护 SM2 App ID、SM2公钥、SM2私钥的值,即可生效使用。

获取到 加密data,先通过公钥验证签名sigature,再通过key和私钥解密得到对称加密密码,然后使用对称密码解密得到数据。

接口返回加密数据示例:

Image Added


错误码表

err_code

err_msg

0

正常

10

report_path参数值不正确

11

datasource_name参数值不正确

12

page_number参数值不正确

13

page_size参数值不正确

14

报表模板文件不存在

15

安全签名不正确

16

start_page参数值不正确

17

end_page参数值不正确

20

报表数据集为空

...