表單增強 API
原有的API集成調(diào)用指可以將表單新提交的數(shù)據(jù)推送到自己的平臺,或在自己的平臺查詢表單提交的數(shù)據(jù)和評論。可點擊查看前文了解:通過API與表單大師互通數(shù)據(jù)
現(xiàn)在高級功能API增強,則是指以接口形式對表單內(nèi)數(shù)據(jù)進行添加和修改。也就是說,可以通過自己的平臺往表單內(nèi)添加數(shù)據(jù)或修改(更新)數(shù)據(jù),支持修改字段內(nèi)容。
新增數(shù)據(jù)
描述
對特定表單中插入一條數(shù)據(jù)
訪問地址
http://api.jsform.com/api/v1/entry/add
訪問方式
POST
參數(shù)
參數(shù)名 | 數(shù)據(jù)類型 | 是否必須 | 示例值 | 默認值 | 描述 |
---|---|---|---|---|---|
form_id | String | 是 | 558226580cf22a4f82d7b49a | 表單ID | |
data | Object | 是 | 見下圖,具體從API列表中獲取 | 新增數(shù)據(jù) |
{
"form_id":"5f7448067c5f3817d79e803c",
"data":{
"field1":"123",
"field2":"dqwd",
"field5":123.0,
"amount":1231,
"couponcode":123123,
"field15":"123",
"create_by":"123"
}
}
返回值
參數(shù)名 | 描述 |
---|---|
status | 狀態(tài) |
message | 如果失敗,用此字段描述失敗原因。如果成功,此字段為空。 |
entry | 數(shù)據(jù)結(jié)構(gòu)參考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": "調(diào)用頻率過高,請稍后再試。",
"status": "error"
}
修改數(shù)據(jù)
描述
對特定表單的特定數(shù)據(jù)進行字段的修改
訪問地址
http://api.jsform.com/api/v1/entry/update
訪問方式
POST
參數(shù)
參數(shù)名 | 數(shù)據(jù)類型 | 是否必須 | 示例值 | 默認值 | 描述 |
---|---|---|---|---|---|
id | String | 是 | 558226580cf22a4f82d7b49a | 數(shù)據(jù)ID | |
data | Object | 是 | 見下圖,具體從API列表中獲取 | 修改的數(shù)據(jù) |
{
"data":{
"create_by":"123"
"field1":"123"
},
"id":"5f8d364a11241a3b584fca1e"
}
返回值
參數(shù)名 | 描述 |
---|---|
status | 狀態(tài) |
message | 如果失敗,用此字段描述失敗原因。如果成功,此字段為空。 |
返回示例
正確
{
"status": "success"
}
錯誤
{
"message": "調(diào)用頻率過高,請稍后再試。",
"status": "error"
}
注意事項
1.API增強為高級功能,旗艦版及以上版本用戶可付費開通
2.上傳文件、子表字段暫不支持
3.所有操作受API次數(shù)限制,每調(diào)用一次計數(shù)一次