如何通过API向工作表读写数据
平台为具有开发能力的用户提供了API接口,可以将工作表和自有系统进行数据对接,将外部数据写入到工作表中或读取工作表中的数据。
应用举例
您在订单管理应用中创建一个订单表,用于统一管理线上和线下的订单。您还有一套线上销售系统用于记录在线订单每当客户在线下单时,就可以通过工作表API接口,直接向《订单》表中 写入一条新的订单数据,即省力,又避免人工录入的出错。
API接口说明
应用管理员打开[API开发文档],可查看本应用下所有的API接口。
企业授权说明
本平台使用基于令牌的身份验证,AppKey 与 SecretKey在应用的开发文档中会提供,超级管理员也可以重新生成。
字段与控件类型对照表
字段ID: 系统为字段自动生成的ID,不能更改,通过API写入数据时需用字段ID代表本字段。
字段名称: 管理员为字段定义的名称。
类型: 字段所选择的控件类型
控件类型编号: 所用控件的类型编号,一般在API传参时使用,不同的类型,筛选方式也会有所不同。
说明: 当前字段使用说明,如数据类似及样例数据,是否支持写入等信息。
工作表别名和字段别名: 由于表ID和字段ID是一串长字符,不方便记忆和书写,可以为工作表和字段设置别名,在API传参时使用别名和用ID具有相同效果。
新增记录接口
应用提供了10多个接口,满足数据的所有操作场景,我们以新建一行记录为例进行说明,即通过API向工作表新增一行记录。
规则
- API请求地址为:https://api.mingdao.com/v2/open/worksheet/addRow
- 参数appkey、sign、worksheetid、controls及controlId可以直接复用右侧已经提供的值。 参数名不需要更改,是根据当前表自动生成的,在测试时只需要修改参数值。
请求示例,可直接复制使用
{
"appKey": "15d5b427b4bbf1b6",
"sign": "ZDRjZDEzM2Q3YzUzMGI1ZDhjOWNhOWQ2MzFiZDkxNDY1NmYyZjBiYjE1YzYzZGMxNGU0MmNjZDA2NjJmYjViNA==",
"worksheetId": "655c79654120176fa4758593",
"controls": [
{
"controlId": "6426808e315e39d1e4dae83e",
"value": "This is a test"
},
{
"controlId": "5e0a02642134520001e19345",
"value": "666.66"
}
],
"triggerWorkflow": true
}
响应参数及返回数据示例
{
"data": "75f221fb-d645-4010-92cb-acced0c73cea",
"success": true
}
错误对照表
ErrorCode | 说明 |
---|---|
0 | 失败 |
1 | 成功 |
10001 | 缺少参数 |
10002 | 参数值错误 |
10005 | 数据操作无权限 |
10007 | 数据不存在 |
10101 | 请求令牌不存在 |
10102 | 签名不合法 |
99999 | 数据操作异常 |
模拟测试
在这里,我们通过一个简单的在线API接口测试,模拟下外部数据的写入。
API在线测试工具:https://hoppscotch.io ,您也可以使用其他API测试工具。
- 将API请求地址粘贴到输入框
- 选择 Post"方式
- 选择 "Body" 提交方式
- Content Type 选择 "application/json"
- 将前面的请求示例代码粘贴到编辑框中
- 点击send按钮提交
- 下方显示提交结果,如果显示 "success": true ,说明已正确写入,可以刷新下工作表查看新数据,创建人为API。
相关参数获取方法
在测试时,我们可以先获取一个固定的参数值进行调试,例如视图ID和行记录ID(rowId)。
行记录ID(rowId)
要获取rowid需打开记录的详情页面。进入工作表>找到目标记录>选择"新页面打开",在打开页面的链接中row/
之后的一串内容就是记录ID。如下图中获取到记录ID(rowId)就是:d0bd3216-5274-4f59-a153-de80ec203838
视图ID
在获取记录列表的时,需要用到视图ID,在接口说明中会显示所有视图名称及视图ID。
文档问题反馈
文档中是否有错别字、内容过期、难以理解等问题? 点此给我们反馈吧