OpenApi使用介绍

使用前提

1.轻流工作区已经升级到对应版本,获取到使用openApi的权限

目前只有ALPHA及以上版本,支持openApi调用。使用前,确保已经升级至ALPHA版本或更高。

2.为自己的应用成功生成accessToken

如果需要通过轻流openApi调取/更新数据,需要先生成一个accessToken,使用这个为凭证调用对应的接口才可以生效。

3. 确保服务器地址在白名单配置中

默认情况下,openApi可以从任何ip调用。为了您数据的安全,可以在工作区管理后台中,设置openApi调用白名单,这样只有白名单列表中的ip才可以通过openApi调用您的数据。

调用OpenApi接口

调用所有的openApi接口时,除了接口文档中列出的必选和可选参数外,所有的接口headers中,都要传递以下参数

(1) accessToken: 拥有调用openApi权限后,可以在工作区管理后台中,生成当前工作区的accessToken,作为身份认证的凭证

接口详细说明

1.接口概览

轻流openApi目前提供以下几个接口,用于获取和更新轻流中的数据

(1)获取工作区中的所有应用

(2)获取某个应用的表单基础信息

(3)获取某个应用的数据

(4)为某个应用添加数据

2. 接口详细说明

(1)获取工作区中的所有应用

  • 请求方式:GET
  • 请求地址:https://open.qingflow.com/service/appList
  • 请求返回结果:
{
  "errCode": 0,
  "errMsg": "ok",
  "result": {
    "appList": [
      {
        "appKey": "string",
        "appName": "string"    
      }, ...
    ]
  }
}

  • 请求返回结果参数说明:
参数
说明
errCode
返回码,0表示正常
errMsg
返回的错误信息
appList
应用列表
appKey
应用的key
appName
应用名

(2)获取某个应用的表单基础信息

  • 请求方式:GET
  • 请求地址:https://open.qingflow.com/service/questionBaseInfo
  • 请求参数:
 参数名
是否必须
 参数说明
 appKey
 要查询应用的appKey
  • 请求返回结果:
{
  "errCode": 0,
  "errMsg": "ok",
  "result": {
    "questionBaseInfos": [
      {
        "queId": 0,
        "queType": 0,
        "queTitle": string,
        "options": [
          {
            "optId": -1,
            "optValue": "选项内容"
          } , …
        ],
        "subQuestionBaseInfos":[
          //和questionBaseInfos相同
        ]
      },…
    ]
  }
}

  • 请求返回结果参数说明:
参数
说明
errCode
返回码,0表示正常
appList
应用列表
queBaseInfos
应用的问题信息
queId
问题的id
queType
问题的类型
queTitle
问题标题
options
选项内容
optId
选项id
optValue
选项内容
subQuestionBaseInfos
表格子问题的信息

(3)获取某个应用的数据

  • 请求方式:GET
  • 请求地址:https://open.qingflow.com/service/applyDataList
  • 请求参数:
 参数名
是否必须
 参数说明
 appKey
 要查询应用的appKey
 pageSize
 每页数据中包含的数据条数
 pageNum
 要获取的页数,从1开始
  • 请求返回结果:
{
  "errCode" : 0,
  "errMsg" : "ok",
  "result" : {
    "pageAmount": 0,
    "pageNum": 0,
    "pageSize": 0,
    "result": [
      {
        "answers": [
          {
            "values": [
              {
                "otherInfo": "string",
                "id": -1,
                "value": "string"
              }, ....
            ],
            "tableValues": [
              //和answers的结构相同
            ],
            "queId": 0,
          }, ....
        ],
        "applyId": 0
      }, ....
    ],
    "resultAmount": 0
  }
}

  • 请求返回结果参数说明:
参数
说明
errCode
返回码,0表示正常
pageAmount
结果总共包含多少页
pageNum
当前页页号
pageSize
页大小
result
数据结果
resultAmount
数据个数
answers
返回的申请列表
values
普通问题的结果
tableValues
表格问题的结果
applyId
申请对应的id

(4)为某个应用添加数据

说明:在添加数据之前,需要先调取“`(2)获取某个应用的表单基础信息“`接口,获取到表单每个问题对应的queId之后,再添加对应的数据

  • 请求方式:POST
  • 请求地址:https://open.qingflow.com/service/apply
  • 请求body信息:
{
  "appKey" : "string",
  "answers":[
    {
      "queId" : -1,  // 获取应用表单基础信息中,得到的目标问题queId
      "values":[
        {
          "value" : "string",
          "otherInfo" : "string",
          "id" : -1
        },...
      ],
      "tableValues":[
        //和answers的结结构相同
      ]
    }, ...
  ]
}
  • 请求body参数说明
参数
说明
errCode
返回码,0表示正常
result
数据结果
answers
返回的申请列表
values
普通问题的结果
tableValues
表格问题的结果
applyId
申请对应的id
queId
问题id

 

错误码说明

错误码
说明
40001
无效的accessToken
40002
达到每日调用次数上限
40003
IP不再可调用白名单内
40004
appKey不存在

目前仅公开部分Api,如有额外Api需求,请通过右下角客服与我们取得联系。

       

相关文章