电子合同API开发文档 v1
搜索
编码转换
一定签首页
1.
API接口文档
2.
对接方案
3.
基本信息
4.
常见问题
5.
公共请求参数
6.
印章管理
6.1
创建个人印章
6.2
获取个人印章列表
6.3
上传个人自定义印章
6.4
添加手写签名
6.5
设置默认印章
6.6
移除印章
6.7
创建企业印章
6.8
上传企业自定义印章
6.9
获取企业印章列表
7.
合同管理
7.1
创建合同
7.2
签署合同-自定义签署
7.3
签署合同-根据关键词签署
7.4
签署合同-h5页面签署
7.5
签署合同-无签章签署
7.6
拒签合同
7.7
撤回合同
7.8
删除合同
7.9
获取合同下载链接
7.10
获取合同状态
7.11
查询合同详情
7.12
合同文件验证,验签
7.13
查询合同列表
7.14
设置签署位置
8.
首页
8.1
首页
9.
app跳转
9.1
首页
9.2
api认证结果页面
10.
信息验证(纯API接口)
10.1
身份证实名认证
10.2
运营商三要素验证
10.3
银行卡三要素验证
10.4
银行卡四要素验证
11.
app获取用户信息
11.1
首页
11.2
查看
11.3
切换
11.4
获取用户等级
12.
验证码
12.1
首页
12.2
app创建
12.3
验证
12.4
检测
13.
数字证书
13.1
首页
13.2
查看
14.
实名认证
14.1
认证首页
14.2
查看认证
14.3
eid重新提交
14.4
查看状态
14.5
查看机构列表
14.6
查看个人账户认证状态
15.
获取支持的银行列表
15.1
首页
15.2
获取全部
15.3
根据关键词搜索
15.4
根据银行名称搜索
16.
企业认证
16.1
对公转账认证
16.2
验证转账金额
16.3
人工审核认证
16.4
法人授权认证
16.5
获取支付版本号
16.6
使用eid进行法人认证
17.
个人认证
17.1
开始认证
17.2
人工认证
17.3
验证扫脸状态
17.4
获取百度认证链接
17.5
验证流程id
17.6
验证腾讯流程ID
17.7
获取腾讯认证数字
17.8
获取认证类型
17.9
获取人脸认证的数字验证码
17.10
根据流程id验证是否通过
17.11
快速切换认证方式
17.12
根据实名id获取认证结果
17.13
获取人脸认证token
17.14
创建URl用于认证成功返回
17.15
验证人脸认证token
18.
主题样式
18.1
查看
18.2
更新
19.
获取公司信息
19.1
获取公司信用代码
19.2
获取地址
19.3
搜索名称
19.4
搜索名称v2
19.5
读取企业信息
19.6
获取企业名称
19.7
生成二维码
20.
企业管理
20.1
企业管理首页
20.2
创建企业
20.3
创建状态
20.4
查看企业详情
20.5
删除企业
20.6
变更企业管理员
20.7
获取成员加入任务
20.8
加入企业
20.9
更新企业LOGO
20.10
查看企业详情
20.11
扫码加入企业
20.12
getConfig
20.13
updateConfig
21.
企业成员
21.1
成员首页
21.2
查看成员
21.3
查看状态
21.4
加入企业
21.5
删除成员
21.6
手动添加成员
21.7
修改成员权限
21.8
扫码申请加入
21.9
readAppList
22.
联系人管理
22.1
获取联系人列表
22.2
查看联系人
22.3
创建联系人
22.4
更新联系人
22.5
删除联系人
23.
公共模板管理
23.1
获取合同模板分类
23.2
首页
23.3
查看
23.4
根据id获取配置
23.5
根据id获取配置历史版本
24.
模板管理
24.1
使用模板生成合同
24.2
更新模板
24.3
添加模板
24.4
删除模板
24.5
新建或修改空白模板
24.6
查看模板
24.7
获取模板列表
24.8
创建模板
24.9
使用模板
24.10
上传模板v3
24.11
更新模板v3
24.12
使用模板发起合同
24.13
重命名模板
25.
优惠券管理
25.1
首页
25.2
优惠券列表
26.
意见反馈
26.1
创建
27.
帮组支持
27.1
获取分类
27.2
首页
27.3
查看
28.
发票管理
28.1
发票首页
28.2
删除发票
28.3
查看发票
28.4
获取可申请金额
28.5
申请发票
28.6
更新发票
29.
登录注册
29.1
使用手机号登录
29.2
登录接口,获取token
29.3
查询号码状态
29.4
重置密码
29.5
注册接口
29.6
快速登录
29.7
绑定手机号
29.8
变更手机号
29.9
查询手机号是否注册
29.10
快速检测手机号是否可以绑定
29.11
api.v1.Login.quickLoginByMp
30.
菜单管理
30.1
首页
31.
在线留言
31.1
首页
32.
新闻管理
32.1
获取分类
32.2
首页
32.3
取列表
32.4
查看
33.
openId管理
33.1
查看
33.2
阿里系获取
33.3
首页
34.
订单管理
34.1
订单首页
34.2
查看订单
34.3
查看订单状态
34.4
删除订单
34.5
创建订单
34.6
验证IOS订单
35.
产品管理
35.1
查看
35.2
首页
35.3
标准版详情
35.4
获取次数
35.5
api价格列表
35.6
IOS产品验证
35.7
获取支付通道
35.8
获取产品分类
35.9
存证产品价格
35.10
获取购买渠道
35.11
检测状态
36.
印章管理 v1-(已下线)
36.1
印章首页
36.2
创建印章
36.3
app手写印章
36.4
上传印章
36.5
更新印章
36.6
查看印章
36.7
删除印章
36.8
创建印章预览
36.9
印章预览
37.
印章模板
37.1
首页
38.
内容搜索
38.1
首页
39.
签署密码
39.1
验证签署密码
40.
签署合同
40.1
查看签署详情
40.2
签署合同
40.3
撤回合同
40.4
拒签合同
40.5
催签
40.6
删除合同
40.7
补签
40.8
获取签署详情
40.9
修改签署人
40.10
获取填写字段
40.11
填写合同
40.12
发送合同到邮箱
40.13
作废合同
40.14
验证作废状态
40.15
重命名合同
40.16
转交合同
41.
短信
41.1
首页
41.2
下发短信
41.3
验证短信
41.4
创建语音验证码
42.
自动测试
42.1
collect测试
42.2
首页
42.3
doc测试
42.4
signed测试
42.5
wy测试
42.6
api.v1.Test.check
42.7
api.v1.Test.test2
42.8
api.v1.Test.test3
42.9
api.v1.Test.sms
42.10
api.v1.Test.time1
42.11
api.v1.Test.time2
42.12
api.v1.Test.showPdf
42.13
api.v1.Test.exits
42.14
api.v1.Test.index2
43.
任务列表
43.1
首页
43.2
未完成的任务
44.
app更新
44.1
首页
44.2
获取更新版本
45.
文件上传
45.1
单个上传
45.2
批量上传
45.3
通过base64上传
45.4
验证文件id
46.
会员管理
46.1
查看
46.2
更新会员资料
46.3
重置密码
46.4
更新头像
46.5
重置签署密码
46.6
更新手机号
46.7
更新邮箱
46.8
更新个人资料
46.9
查看个人资料
46.10
查看通知
46.11
查看号码
46.12
查看号码是否能使用
46.13
删除会员
46.14
使用验证码修改密码
47.
合同管理
47.1
创建合同
47.2
获取分类-app
47.3
获取分类
47.4
合同管理首页
47.5
查看状态
47.6
查看合同详情
47.7
每天使用量
47.8
查看合同转换状态
47.9
更新合同
47.10
获取文档url
47.11
查询签署状态
47.12
查询合同是否更新
47.13
获取合同缩略图
48.
合同签署统计
48.1
统计每天
49.
清除缓存
49.1
用户类
49.2
管理类
50.
v2验证码
50.1
首页
51.
软件下载
51.1
首页
51.2
macOS下载
51.3
windows下载
51.4
android下载
52.
v2跳转app
52.1
首页
53.
在线客服
53.1
首页
53.2
分配客服
53.3
自动处理
54.
二维码
54.1
阿里定制二维码
54.2
腾讯类二维码
54.3
二维码首页
54.4
下载二维码
55.
企业更新
55.1
首页
55.2
开始更新
56.
v2上传
56.1
首页
57.
url管理
57.1
首页
58.
自定义验证码
58.1
获取token
59.
合同下载
59.1
下载合同
59.2
读取合同信息
59.3
通过二维码获取
60.
文档自动处理
60.1
首页
61.
创建用户
61.1
个人账户创建
61.2
查询个人账户信息
61.3
修改个人账户信息
61.4
设置签署密码
61.5
注销个人账户
61.6
获取用户列表
61.7
企业账户创建
61.8
读取企业信息
61.9
更新企业信息
61.10
注销企业信息
61.11
清除所有测试账户
61.12
搜索用户
61.13
获取用户easy_id
62.
文件上传
62.1
上传需要签署的合同
62.2
合同模板上传
62.3
合同处理状态
62.4
上传合同附件
62.5
自定义印章上传
63.
异步通知
63.1
eid通知
64.
验证码
64.1
首页
64.2
验证
65.
企业验证(纯API接口)
65.1
企业对公转账认证
65.2
验证对公转账金额
66.
出证管理
66.1
出证首页
66.2
申请出证
66.3
出证下载
67.
第三方登录
67.1
开始登录
67.2
返回事件
68.
文档创建
68.1
查看
68.2
首页
68.3
异步-文档详情
68.4
异步-文档通知
68.5
异步-用户详情
68.6
异步-文档保存
68.7
异步-文档重命名
68.8
异步-可编辑用户
69.
实名认证
69.1
获取银行卡四要素认证地址
69.2
获取手机三要素认证地址
69.3
获取支付宝授权认证地址
69.4
获取人工审核认证地址
69.5
获取个人的认证状态
69.6
获取企业对公转账认证地址
69.7
获取企业法人授权认证地址
69.8
获取企业人工审核认证地址
69.9
获取企业的认证状态
69.10
腾讯人脸授权
69.11
id认证
70.
自动测试
70.1
首页
71.
数据同步
71.1
阿里系列
71.2
取临时文件
72.
服务管理
72.1
首页
73.
权限管理
73.1
权限首页
73.2
获取权限列表
73.3
创建权限组
73.4
修改权限组
73.5
删除权限组
73.6
查看权限组
74.
图片合并pdf
74.1
首页
74.2
创建任务
74.3
创建任务新版本
75.
上传图片到服务器
75.1
开始上传
76.
企业印章管理
76.1
印章首页
76.2
使用模板添加印章
76.3
上传图片识别印章
76.4
更新印章
76.5
查看印章
76.6
删除印章
76.7
使用模板添加印章-预览
76.8
使用印章(无需审批)
76.9
审批列表
76.10
申请审批
76.11
审批
77.
个人签名管理
77.1
签名首页
77.2
删除签名
77.3
上传签名
77.4
更新签名
77.5
查看签名
77.6
删除签名
77.7
制作签名
77.8
添加手写签名
77.9
获取手写签名url地址
78.
审批管理
78.1
查看审批角色列表
78.2
提交用印请求
78.3
查看审批列表
78.4
批准/拒绝用印
78.5
查看申请
78.6
根据id获取详情
78.7
查看审批角色列表
79.
开发者设置
79.1
查看开发设置
79.2
设置Ip白名单
79.3
重置appKey
79.4
查看计费列表
80.
签署意愿认证
80.1
手机认证-发送手机验证码
80.2
手机认证-验证手机验证码
81.
其他接口
81.1
检测pdf文档是否加密
81.2
验证pdf文档密码是否正确
81.3
搜索关键词坐标
81.4
获取当前ip
82.
钉钉事件处理
82.1
钉钉事件处理
83.
监控
83.1
监控
84.
流程信息验证
84.1
腾讯类产品验证
85.
计费模型
85.1
获取产品计费模型
86.
帮组支持
86.1
首页
86.2
更新支持
87.
合同归档
87.1
合同归档首页
87.2
对合同进行归档
87.3
查看归档分类
87.4
创建归档分类
87.5
更新归档分类
87.6
删除归档分类
88.
台账管理
88.1
台账首页
88.2
查看台账
88.3
查看合同台账内容
88.4
创建台账
88.5
更新台账
88.6
删除台账
89.
短网址
89.1
首页
90.
腾讯功能类
90.1
首页
90.2
验证
91.
帮组中心
91.1
查询结果
91.2
获取分类
91.3
获取列表
91.4
读取详情
91.5
获取全部结果
92.
腾讯云异步事件
92.1
事件处理
92.2
事件处理v1
92.3
事件处理异步
93.
腾讯云异步事件
93.1
事件v1
94.
语音功能
94.1
示范
95.
WeChat
95.1
获取签名
96.
BaiduFace
96.1
成功事件
96.2
失败事件
96.3
公共处理
97.
模板管理
97.1
创建模板
97.2
修改模板
97.3
更新模板字段
97.4
获取模板控件
97.5
读取模板
97.6
获取模板参数
97.7
读取模板字段
97.8
获取v31模板控件
97.9
更新模板内容
97.10
删除模板
98.
WPS异步事件
98.1
首页
99.
微信小程序
99.1
事件
100.
备注
100.1
保存备注
100.2
读取备注
101.
企业微信
101.1
异步事件
101.2
获取票据
102.
模板管理
102.1
获取模板列表
102.2
上传模板
102.3
获取模板详情
103.
会员任务
103.1
首页
104.
公共提醒
104.1
公共提醒
104.2
公共提醒v2
105.
支付宝授权信息
105.1
支付宝授权信息
106.
字体配置
106.1
获取字体配置
107.
Nginx转发(apiCenter)
107.1
v1版本
107.2
v2版本
107.3
v3版本
108.
存证管理
108.1
存证首页
108.2
查看存证详情
108.3
获取证书
108.4
创建存证
108.5
获取配置
109.
二维码模板
109.1
二维码模板首页
109.2
创建合同
109.3
创建二维码模板
109.4
更新二维码模板
109.5
更新二维码状态
109.6
获取二维码详情
109.7
根据模板id查询
109.8
删除二维码模板
110.
企业信息
110.1
搜索企业
111.
发送信息
111.1
首页
112.
二维码模板公共页
112.1
查询
113.
企业工商信息
113.1
精准查询企业
113.2
搜索企业
114.
短信接口
114.1
发送短信(免审)
115.
常用工具
115.1
身份证号码规则验证
115.2
印章背景去除
116.
Git管理
116.1
首页
117.
Oauth
117.1
登录
117.2
返回事件
118.
短网址
118.1
首页
119.
wps功能
119.1
首页
120.
票据
120.1
读取模板
121.
Tx
121.1
首页
121.2
api.v10.Tx.callback
122.
Captcha
122.1
首页
122.2
验证
123.
状态查询
123.1
成功事件
123.2
失败事件
124.
ApiStoreUser
124.1
创建
124.2
获取token
125.
填写内容
125.1
首页
125.2
删除
126.
Server
126.1
slave
126.2
检查状态
127.
V31模板管理
127.1
获取链接
127.2
填写内容
127.3
获取URL
127.4
模板设置
127.5
查询
127.6
更新
128.
系统模板
128.1
首页
128.2
获取分享链接
128.3
填写系统模板
128.4
获取链接
128.5
读取详情
128.6
修改系统模板
128.7
填写信息readFillDetailsByV1
129.
V32系统模板
129.1
首页
130.
WpsTool
130.1
读取
130.2
创建
130.3
签署
130.4
保存
130.5
重命名
131.
Link
131.1
v32tpl
132.
快捷方式
132.1
首页
133.
V32模板管理
133.1
获取功能
133.2
读取配置
133.3
获取配置
134.
发送邮件
134.1
发送邮件
135.
优惠券
135.1
查看
135.2
领取
136.
优惠券
136.1
获取列表
136.2
首页
136.3
未使用的
137.
Deposit
137.1
获取配置
138.
文档编辑
138.1
读取文档信息
138.2
保存文档信息
139.
创建模板
139.1
删除
139.2
创建
139.3
列表
140.
OpenLink
140.1
首页
141.
oss存储管理
141.1
获取配置
141.2
权限验证
141.3
反馈事件
142.
历史记录
142.1
首页
142.2
删除
143.
文档管理
143.1
文档管理首页
144.
会员异步任务管理
144.1
任务列表
144.2
删除任务
144.3
创建任务
144.4
读取任务
144.5
获取状态
145.
表单
145.1
填写表单
146.
账户验证
146.1
账户验证
147.
v3.Templates
147.1
获取配置
147.2
获取支持的组件
148.
快速签章
148.1
快速签章
148.2
获取签署结果
149.
账户绑定信息
149.1
首页
149.2
删除绑定信息
150.
模板管理
150.1
修改模板
150.2
获取模板信息
150.3
填写模板
150.4
查看填写详情
151.
获取app合同信息
151.1
获取列表
152.
SmsEvent
152.1
aliyun
152.2
aliyunTest
153.
合同发起方式
153.1
上传文件发起合同
153.2
使用模板发起合同
图片合并pdf
API类型:
印章管理
合同管理
首页
app跳转
信息验证(纯API接口)
app获取用户信息
验证码
数字证书
实名认证
获取支持的银行列表
企业认证
个人认证
主题样式
获取公司信息
企业管理
企业成员
联系人管理
公共模板管理
模板管理
优惠券管理
意见反馈
帮组支持
发票管理
登录注册
菜单管理
在线留言
新闻管理
openId管理
订单管理
产品管理
印章管理 v1-(已下线)
印章模板
内容搜索
签署密码
签署合同
短信
自动测试
任务列表
app更新
文件上传
会员管理
合同管理
合同签署统计
清除缓存
v2验证码
软件下载
v2跳转app
在线客服
二维码
企业更新
v2上传
url管理
自定义验证码
合同下载
文档自动处理
创建用户
文件上传
异步通知
验证码
企业验证(纯API接口)
出证管理
第三方登录
文档创建
实名认证
自动测试
数据同步
服务管理
权限管理
图片合并pdf
上传图片到服务器
企业印章管理
个人签名管理
审批管理
开发者设置
签署意愿认证
其他接口
钉钉事件处理
监控
流程信息验证
计费模型
帮组支持
合同归档
台账管理
短网址
腾讯功能类
帮组中心
腾讯云异步事件
腾讯云异步事件
语音功能
WeChat
BaiduFace
模板管理
WPS异步事件
微信小程序
备注
企业微信
模板管理
会员任务
公共提醒
支付宝授权信息
字体配置
Nginx转发(apiCenter)
存证管理
二维码模板
企业信息
发送信息
二维码模板公共页
企业工商信息
短信接口
常用工具
Git管理
Oauth
短网址
wps功能
票据
Tx
Captcha
状态查询
ApiStoreUser
填写内容
Server
V31模板管理
系统模板
V32系统模板
WpsTool
Link
快捷方式
V32模板管理
发送邮件
优惠券
优惠券
Deposit
文档编辑
创建模板
OpenLink
oss存储管理
历史记录
文档管理
会员异步任务管理
表单
账户验证
v3.Templates
快速签章
账户绑定信息
模板管理
获取app合同信息
SmsEvent
合同发起方式
接口名称:
首页
创建任务
创建任务新版本
请求地址:
请求方法:
Header 请求参数:
参数名
是否必填
长度
类型
默认值
描述
内容
appId
是
32
string
-
贵司的appId,可在后台可以查看
自动保存最后一次输入的appId
signature
是
64
string
-
签名效验,请参考签名生成
version
是
6
long
-
版本号
token
否
60-256
string
-
用户的token,可通过用户登录接口获取Token
自动保存最后一次输入的Token
clientType
否
2-10
string
API
用户客户端类型,如WEB、H5、APP、API等
clientId
否
32
string
-
用户客户端ID,请传递真实的客户端ID
添加参数
body 请求参数:
参数名
是否必填
长度
类型
默认值
描述
内容
添加参数
我已阅读并同意授权协议
查看《授权协议》
发送请求
返回JSON内容
原始返回内容
请求Header参数
请求Body参数
请求Query参数