电子合同API开发文档 v5

签署合同-h5页面签署

接口地址:https://api.1dq.com/v5/Contracts/h5signed.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
通过h5网页签署合同,也可以通过纯api接口完成,
备注:
1、如果该用户已经签署合同,那么该链接会变成预览合同
2、可重复调用,有效期20分钟
3、如果合同是企业签署,请传递企业的easy_id , 如果是个人签署,传递个人的easy_id
4、个人必须完成实名认证之后才可以签署,企业必须企业和经办人都完成认证才可以签署合同
5、微信用户可直接跳转到小程序签署; wx.navigateToMiniProgram({ appId: 'wx86be3e47df5e5e65', path: '返回的url,不包含域名和#号' })

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 18 STRING -
签署用户的easy_id,如果有多个用户需要签署,请循环调用本接口,如果传递number参数,该参数可不传递
175592531139104768
open_id - STRING -
签署用户的open_id
9e4568dc-a3fb-11ea-864b-0242ac110003
words_id - STRING -
合同id
11529272-d742-11ea-a75a-0242ac110011
btn_text - STRING 确定签署合同
按钮文字
channel - STRING -
通道名称 可选项 api/autoApi
color - STRING -
按钮颜色
000000
display_date - INT 1
是否显示日期选择,1显示 -1不显示,默认显示
display_handwritten_signature - INT 1
是否显示手写签名,1显示 -1不显示,默认显示
display_personal_tpl - INT -
隐藏个人模板印章,1显示,-1隐藏
display_place - INT 1
是否显示骑缝章,1显示 -1不显示,默认显示
display_public_header - STRING -
操作条,如果channel传递api默认不显示,传递autoApi默认显示
display_success_footer - INT -
签署成功,再次预览文档下方按钮,1显示,-1隐藏,新对接的客户已取消该参数,统一为不显示
display_success_header_help - INT -
隐藏顶部帮助图标,1显示,-1隐藏
display_success_page - STRING -
是否显示签署成功页面,1显示,-1直接跳转到redirect_url, 默认显示成功签署的页面
display_system_seal - INT 1
是否显示系统印章选择,1显示 -1不显示,默认显示
number - STRING -
通过手机号/邮箱 获取免登陆链接
org_id - STRING -
签署机构的org_id ,如果存在
abf447a8-ad71-11ea-b95e-0242ac320a0c
redirect_url - STRING -
签署成功后返回的地址(网址需要能正常访问),如果设置了不显示签署成功页面,当您提供的网址无法正常访问时,页面可能会一直等待

请求示范

 POST https://api.1dq.com/v5/Contracts/h5signed.json
 {
    "btn_text": "确定签署合同",
    "channel": "",
    "color": "000000",
    "display_date": "1",
    "display_handwritten_signature": "1",
    "display_personal_tpl": "",
    "display_place": "1",
    "display_public_header": "",
    "display_success_footer": "",
    "display_success_header_help": "",
    "display_success_page": "",
    "display_system_seal": "1",
    "easy_id": "175592531139104768",
    "number": "",
    "redirect_url": "",
    "words_id": "11529272-d742-11ea-a75a-0242ac110011"
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

----url

- STRING 用户可访问该链接快速签署合同,也可使用该链接跳转到微信小程序签署

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "url": "https:\/\/e.1dq.com\/#pages\/users\/contractManagement\/sign?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTSEVSTE9DSyBKSUFTSFVEQVRBLkNPTSIsImlhdCI6MTYxOTY2NDAyNywiZXhwIjoxNjE5NjY1ODI3LCJhdWQiOiJKSUFTSFVEQVRBIiwic3ViIjoiUFVCTElDVVNFUiIsImRhdGEiOnsidXNlcl9pZCI6ODM2Mjk2OTg3LCJvcGVuX2lkIjo4MzYyNzMzOTMsImFsbG93QWNjZXNzTW9kZWxMaXN0IjpbXSwiYXBwX2lkIjo4MzYyNzMzOTN9fQ.s2VKzr-ROC3OvMVcRTSox-ixQaztI6xupaWQmaY80U0&channel=autoApi&words_id=c52d4c20-a59f-11eb-8a27-0242ac110003&open_id=cea258ea-a59f-11eb-b527-0242ac110003&display_date=1&display_system_seal=1&display_handwritten_signature=1&display_place=1&display_personal_tpl=1&display_success_header_help=1&display_success_footer=1&display_header=-1&display_public_header=1"
    }
}

失败示范

{
    "code": 404,
    "msg": "当前合同已经签署或当前状态不允许签署",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码