如何通过工作表API读写数据


平台为具有开发能力的用户提供了API接口,可以将工作表和自有系统进行数据对接,将外部数据写入到工作表中或读取工作表中的数据。

应用举例

您在应用中创建一个《订单》表,用于统一管理线上和线下的订单。您另外有一套销售系统,每当客户在线下单时,就可以通过工作表API接口,直接向明道云的《订单》表中 写入一条新的订单数据,即省力,又避免人工录入的出错。

API接口说明

进入该应用下所有工作表的API接口文档说明。

image.png

企业授权说明

明道云使用基于令牌的身份验证,AppKey 与 SecretKey请系统超级管理员进入企业后台获取,也可以重新生成。

字段与控件类型对照表

image.png

字段ID:系统为字段自动生成的ID,不能更改,通过API写入数据时需用字段ID代表本字段。

字段名称:用户为字段自定义的名称。

说明:当前字段的数据类似及样例数据, 如果标记为“暂不支持”,则不能进行写入。

数据API

我们提供了9个接口、满足数据的所有操作场景

  • 获取列表 POST
  • 新建行记录 POST
  • 批量新建行记录 POST
  • 获取行记录详情 GET
  • 获取行记录详情 POST
  • 更新行记录详情 POST
  • 批量更新行记录详情 POST
  • 删除行记录 POST
  • 获取关联记录 POST

我们以新建一行记录为例进行说明,即通过API向工作表新增一行记录

image.png

规则

请求参数

image.png

控件数据

请求示例

{
  "appKey": "6ed5ee4bec7e05aa",
  "sign": "Yjk5MzJiZjYxMTAwOGM2NGY5YjVkYjkzYWMyOWVmZGZhMmVkOGFiNGQ4Zjg4N2VmMGMxNzE2ODcyOWY5N2MwOQ==",
  "worksheetId": "5d8c69c4e451b80001fd7288",
  "controls": \[
    {
      "controlId": "5d8c69c4e451b80001fd726b",
      "value": "测试"
    }
    {
    "controlId":"5d8c69c4e451b80001fd726d"
    "value":"通过"
    }
  \]
}

响应参数及返回数据示例

{
    "data": "75f221fb-d645-4010-92cb-acced0c73cea",
    "success": true
}

错误对照表

image.png

模拟测试

在这里,我们通过一个简单的在线API接口测试,模拟下外部数据的写入。

地址:https://www.sojson.com/http/test.html ,您也可以使用其他API测试工具。

image.png

A:选择为 https , 并将API请求地址粘贴到输入框

B:选择Post 方式、UTF8 。

C:选择 JSON参数设置。将请求代码粘贴进去。

image.png

D:点击【模拟请求】按钮

E:请求后返回的结果

如果 success": true ,说明已正确写入,可以刷新下工作表查看新数据,创建人为API。

image.png

相关参数获取方法

在测试时,我们可以先获取一个固定的参数值进行调试,例如视图ID和记录ID。

记录ID

在测试获取一条记录详情的接口中,一条记录的记录ID的获取方法如下

image.png

视图ID

在获取记录列表的时,需要用到视图ID

image.png

results matching ""

    No results matching ""