表单增强 API
原有的API集成调用指可以将表单新提交的数据推送到自己的平台,或在自己的平台查询表单提交的数据和评论。可点击查看前文了解:通过API与表单大师互通数据
现在高级功能API增强,则是指以接口形式对表单内数据进行添加和修改。也就是说,可以通过自己的平台往表单内添加数据或修改(更新)数据,支持修改字段内容。
新增数据
描述
对特定表单中插入一条数据
访问地址
http://api.jsform.com/api/v1/entry/add
访问方式
POST
参数
参数名 | 数据类型 | 是否必须 | 示例值 | 默认值 | 描述 |
---|---|---|---|---|---|
form_id | String | 是 | 558226580cf22a4f82d7b49a | 表单ID | |
data | Object | 是 | 见下图,具体从API列表中获取 | 新增数据 |
{
"form_id":"5f7448067c5f3817d79e803c",
"data":{
"field1":"123",
"field2":"dqwd",
"field5":123.0,
"amount":1231,
"couponcode":123123,
"field15":"123",
"create_by":"123"
}
}
返回值
参数名 | 描述 |
---|---|
status | 状态 |
message | 如果失败,用此字段描述失败原因。如果成功,此字段为空。 |
entry | 数据结构参考API中的描述。 |
返回示例
正确
{
"entry": {
"field1": "123",
"field2": "dqwd",
"field5": 123.0,
"amount": 1231,
"couponcode": 123123,
"field15": "123",
"create_by": "123",
"form_name": "表单编辑0930",
"form_id": "5f7448067c5f3817d79e803c"
},
"status": "success"
}
错误
{
"message": "调用频率过高,请稍后再试。",
"status": "error"
}
修改数据
描述
对特定表单的特定数据进行字段的修改
访问地址
http://api.jsform.com/api/v1/entry/update
访问方式
POST
参数
参数名 | 数据类型 | 是否必须 | 示例值 | 默认值 | 描述 |
---|---|---|---|---|---|
id | String | 是 | 558226580cf22a4f82d7b49a | 数据ID | |
data | Object | 是 | 见下图,具体从API列表中获取 | 修改的数据 |
{
"data":{
"create_by":"123"
"field1":"123"
},
"id":"5f8d364a11241a3b584fca1e"
}
返回值
参数名 | 描述 |
---|---|
status | 状态 |
message | 如果失败,用此字段描述失败原因。如果成功,此字段为空。 |
返回示例
正确
{
"status": "success"
}
错误
{
"message": "调用频率过高,请稍后再试。",
"status": "error"
}
注意事项
1.API增强为高级功能,旗舰版及以上版本用户可付费开通
2.上传文件、子表字段暂不支持
3.所有操作受API次数限制,每调用一次计数一次