数据服务 API

SmartChart的数据集功能, 可以非常方便的实现数据对外微服务 #

权限设定 #

帐号访问权限 #
  • 超级管理员可以在首页右上角用户图标的菜单中, 找到"服务配置"打开
  • 比如需要调用API的用户名为test 和 test2，用户名需要是在你的用户设定中存在的,内容如下:
{
  "test": {
    "token": "smartchart"
  },
  "test2": {
   "token": "smartchartxxx",
   "host": ["10.10.10.10","10.10.10.23"],
   "limit": 60,
   "log":1,
   "cors": 1
 }
}

可选设定参考test2 host:API白名单配置，limit:一分钟内可调用次数, log:日志记录方式. cors:永许跨域访问

数据集权限 #

  • 在数据集权限管理中, 将你需要开放的数据集的权限, 设定给对应的用户

请求方式 #

加密接口请求方式（推荐） #

下文提到的"秘钥"即上文设定中的"token", 注意上文的token非下文提到的token

GET 请求 # 

#接口请求格式: 
url= '/echart/dataset_api/?visitor=xxx&token=xxx&type=xxx&stamp=xxxxx&param={"xx":"xxx","xx":"xxxx"}'
# 参数说明
visitor: 用户名
type: 接口数据集ID
stamp: 时间戳(1970年1月1日到生成时间的毫秒数)
token: 采用sha1加密, token=SHA1(秘钥 + stamp + visitor + type)
param: 数据集查询参数清单(可选), 格式json字符串, 如: '{"参数A":"xxxx", "参数B":"xxxx"}'
# 接口返回格式Json:
{
"data":[[]],
"result":"success",
"maxpg":1,
"pg":1
}
# 返回值说明:
data : 二维数组, 第一行为表头, 样列数据如下
[["heroname", "qty"],["镜",658],["猪八戒",591]]
result : success 或 error
maxpg/pg : GET请求固定为1不分页

POST请求(适用于后台定时同步数据，查询请用GET请求方法) # 

#接口请求格式:
url: /echart/dataset_api/
# 请求参数data: 
{
"visitor":"xxx",
"token":"xxx",
"stamp":xxxxx,
"type":"xxx",     
"pagesize":"xxx",  
"pg":"xxx",       
"param":'{"xxx":"xxxx"}'  
}
# data参数说明
visitor: 用户名
type: 接口数据集ID
stamp: 时间戳(1970年1月1日到生成时间的毫秒数)
token: 采用sha1加密, token=SHA1(秘钥 + stamp + visitor + type)
Pagesize: 采用分页, 每页的数据量大小
pg: 返回第几页
param: 数据集查询参数清单(可单), 拼接成json字符串, 如:
'{"参数A":"xxxx", "参数B":"xxxx"}'


#接口返回格式Json: 
{
"data":[[]],
"result":"success",
"maxpg":xxx,  #最大页数
"pg":xx,  #当前页数
"casheflag": xx,  #如果是999说明命中缓存
"total":xx,   #总条数
}

注意： 只有post是分页的, 第一页是带标题的， 后面页不带标题 由于post方式会使用缓存进行分页,如命中缓存传参不会生效，小数据量请使用get方式请求 不要请求大数据量，大量数据请采用limit, offset传参方式进行分页

不加密请求方式(简单但不安全） # 

GET 请求
#接口请求格式: 
url= '/echart/dataset_api/?visitor=xxx&token=xxx&type=数据集名或id'
#接口返回格式Json: 
{
"data":[[]],
"result":"success",
"maxpg":1,
"pg":1
}

POST请求
#接口请求格式:
url: /echart/dataset_api/
data: 
{
"visitor":"xxx",
"token":"xxx",
"type":"xxx",      #数据集名或id名
"pagesize":"xxx",  #每页数据条数
"pg":"xxx",        #返回第几页
"param":'{"xxx":"xxxx"}'  #参数可选
}
#接口返回格式Json: 
{
"data":[[]],
"result":"success",
"maxpg":xxx,  #最大页数
"pg":xx,  #当前页数
"casheflag": xx,  #如果是999说明命中缓存
"total":xx,   #总条数
}

注意:
只有post是分页的, 第一页是带标题的, 后面页不带标题
由于post方式会使用缓存, 小数据量建议你使用get方式请求
Edit Edit this page