番茄表单OpenApi功能概述
使用场景
如果你具有开发能力,可以通过API获取表单定义及数据、提交新数据、也可提供自己平台的API来实时获取表单中新提交的数据。
首先,需要在 [增值服务] —> [OpneAPi] 中通过设置appSecret,开启你的API支持。
目前番茄表单分钉钉版和网页版两个版本
钉钉版
钉钉版番茄表单,只能在钉钉容器内使用,或是在浏览器上手机钉钉扫码登录。
钉钉版访问:https://ding.cjfx.cn
网页版
网页版番茄表单,需在非钉钉浏览器上用邮箱、手机号、微信扫码登录使用,或通过微信公众号进入使用。
网页版访问:https://fanqier.cn 河北省地区使用:https://cjfx.cn
使用限制
1. 仅对企业版用户开放API接口
2. 钉钉版中如果你对表单进行了加密,则无法正常使用该功能
安全性
除了数据推送到第三方平台之外,番茄表单提供的API都需要授权认证。默认情况下,你在 [增值服务] —> [OpneAPi] 中会获取到一个appid(它是你在番茄系统中的唯一标识符),但为了调用的安全,还需设置一个appSecret,并使用该appSecret和appid获取access_token。
获取access_token
请求方式:POST
请求地址:
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
appId | String | 是 | 分配的appId |
appSecret | String | 是 | 随机生成的appSecret |
返回结果:
参数 | 类型 | 说明 |
---|---|---|
data | Object | |
└ access_token | String | 根据appId和appSecret生成的token,有效期2小时,在有效期内多次调用,会延长两个小时 |
status | Object | |
└ code | Number | 业务状态码,只有返回200才是正常调用成功 |
└ message | String | code对应的描述信息 |
我们为你提供的API
获取表单列表接口
获取表单结构接口
获取表单回复数据列表接口
提交数据接口
表单回复数据推送接口
表单数据组件定义
备注:番茄表单API接口频率限制------相同接口一秒钟只能调一次(1次/秒)