使用表单开放Api获取数据

使用表单 OpenAPI 拉取数据

TDuckX 提供 表单数据开放 API，支持第三方系统通过接口方式同步表单数据，用于：

  • 数据大屏展示
  • BI 数据分析
  • OA / CRM 系统数据集成
  • 数据仓库同步
  • 自动化业务流程

系统通过 JSON 格式向第三方系统提供数据接口，外部系统可以 定时拉取数据进行同步。

建议同步频率：每 30 分钟一次。

一、使用流程

使用数据同步 API 的基本流程如下：

1️⃣ 在 数据大屏 / BI 系统后台 配置「表单数据源」

2️⃣ 填写 TDuckX 提供的 数据接口地址

3️⃣ 系统定时调用接口 拉取数据进行同步

示意：

数据同步流程

二、字段结构同步 API

该接口用于获取 表单字段结构信息，便于第三方系统提前创建数据表结构。

接口地址

GET
https://x.tduckcloud.com/tduck-api/sync/form/fields?apiKey=你的APIKEY

返回数据说明

接口返回 表单字段结构信息，包括：

字段 说明
formKey 表单唯一标识
value 字段ID
label 字段名称
type 字段类型
customField 是否自定义字段
scheme 字段配置

返回示例

{
  "code": 200,
  "msg": null,
  "data": {
    "formKey": "SuKtWkZB",
    "fields": [
      {
        "value": "input1773629696276",
        "label": "邮箱",
        "type": "INPUT",
        "customField": true
      },
      {
        "value": "input1773629698446",
        "label": "单行文本23",
        "type": "INPUT",
        "customField": true
      },
      {
        "value": "totalScore",
        "label": "分数",
        "type": "NUMBER",
        "customField": false
      },
      {
        "value": "serialNumber",
        "label": "提交序号",
        "type": "serialNumber",
        "customField": false
      },
      {
        "value": "createTime",
        "label": "提交时间",
        "type": "DATE",
        "customField": false
      }
    ]
  },
  "success": true
}

三、表单数据同步 API

该接口用于获取 表单提交数据。

支持分页查询，适合第三方系统定时拉取同步。

接口地址

GET
https://x.tduckcloud.com/tduck-api/sync/form/data?apiKey=你的APIKEY

返回数据结构

字段 说明
id 数据ID
dataId 数据唯一标识
formKey 表单Key
serialNumber 提交序号
createTime 提交时间
originalData 用户提交数据
submitRequestIp 提交IP
submitAddress 提交地址
submitBrowser 浏览器
submitOs 操作系统

返回示例

{
  "code": 200,
  "success": true,
  "data": {
    "records": [
      {
        "id": 632325,
        "dataId": "c3d7aed06eb74160a06432c731cffc62",
        "formKey": "SuKtWkZB",
        "serialNumber": 1,
        "createTime": "2026-03-16 10:55:44",

        "originalData": {
          "input1773629696276": "test@qq.com",
          "input1773629698446": "123",
          "totalScore": 1
        },

        "submitRequestIp": "120.228.110.83",
        "submitAddress": "湖南省-长沙市",
        "submitBrowser": "Chrome",
        "submitOs": "Windows"
      }
    ],
    "total": 4,
    "size": 10,
    "current": 1,
    "pages": 1
  }
}

四、数据同步方式

推荐使用 定时任务同步：

同步方式 说明
定时同步 每 30 分钟调用 API
全量同步 获取全部数据
分页同步 按页拉取数据

常见集成系统：

  • OA系统
  • CRM系统
  • BI分析平台
  • 数据仓库
  • 数据大屏系统

五、数据大屏集成（TReport）

TDuckX 还可以与 TReport 可视化大屏项目进行数据集成，实现：

  • 表单数据实时统计
  • 数据可视化展示
  • 图表分析
  • 业务数据大屏

示例效果：

数据大屏示例

数据大屏示例

详细介绍：

开源表单集成可视化大屏： https://zhuanlan.zhihu.com/p/696585191

六、适用场景

该 API 适用于以下场景：

  • 表单数据同步到 BI系统
  • 表单数据同步到 CRM / OA
  • 表单数据同步到 数据仓库
  • 表单数据驱动 数据大屏
  • 表单数据 自动化业务流程