电子合同API开发文档 v5

创建合同

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

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

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

接口描述:
创建合同
备注:
1、如果需要在web.1dq.com 中看到所有的合同,如果signed_data 中没有您企业的easy_id; 需要 增加参数copy_data = 您企业的easy_id
2、需要要把easy_id放在签署人中,只有signed_data中用户才能签署合同

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 18 STRING -
发起方的id,如您账户存在多个企业,每个企业均不同
175592531139104768
file_id 36 STRING -
文件Id,通过上传文件接口获得,如果传递了tpl_id,该参数可为空
signed-ce5858499044c9b8fbbaa272754c145a-108d9e29-0001
name - STRING -
合同名称
项目合同协议
open_id - STRING -
发起方个人账户的open_id, 如果合同属于机构请填写org_id
e4c9cf96-a815-11ea-95b6-0242ac110003
signed_data - JSON -
签署人列表,最多10人,使用JSON 格式传递,格式为 [ { "open_id": "个人账户的open_id必填项", "org_id": "选填-机构的org_id请确保该个人已经加入在这个机构内" }, { "open_id": "个人账户的open_id", "company_org_id": "选填" } ]
查看示范
[ { "open_id": "e4c9cf96-a815-11ea-95b6-0242ac110003", "org_id": "de9beeae-a817-11ea-89a2-0242ac110003" } ]
signed_data - STRING -
该份合同需要哪些人签署,请填写签署人的easy_id,多个用,号分开
175592531139104768, 175592531139104768
attachment - JSON -
附件列表,JSON LIST格式,通过附件上传接口上传可获取到id,注意:如非LIST格式系统会忽略,请参考示范; 在新版本中,附件将合并到主合同中,新版本最多20个附件,如附件过大,将导致合同签署或预览缓慢; 附件无需签署,但同样具备法律效力,(如您附件过大,或数量较多请使用旧版本)
查看示范
[ { "file_id": "signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006", "file_name": "附件1" }, { "file_id": "signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006", "file_name": "附件2" } ]
ca_type - INT 1
CA数字证书类型,1 系统默认,最优选择;其他请与商务联系
1
channel - STRING api
通道名称,默认api,可选项api/autoApi
api
copy_custom_user - JSON -
选填项,自定义抄送人,无需先创建用户,JSON数组,适用场景可参考官网发起合同或与客服联系
查看示范
[ { "sign_role": "甲方", "sign_name": "姓名", "sign_number": "电话", "sign_company": "选填项,公司名", "sign_seal_hand": 1, "sign_seal_tpl": 1, "sign_class": 1 } ]
copy_data - JSON -
抄送人列表, 使用JSON 格式传递,格式为 [ { "open_id": "个人账户的open_id必填项", "org_id": "选填-机构的org_id请确保该个人已经加入在这个机构内" }, { "open_id": "个人账户的open_id", "company_org_id": "选填" } ]
null
copy_data - STRING -
选填项,该份合同需要抄送给哪些,请填写抄送人人的easy_id,多个用,号分开
deposit_certificate_type - INT 1
存证类型,默认1支付宝存证,1支付宝存证,2其他区块链存证,-1无需存证,
1
file_end_date 20 STRING -
合同到期日期,为空不设置,格式为 2010-12-01 00:00:00
notice_signed - STRING 1
是否通知签署人, 1通知 -1 不通知,默认不通知
org_id - STRING -
发起方主体机构的org_id, 如果这份合同属于机构,请填写
de9beeae-a817-11ea-89a2-0242ac110003
pdf_password 50 STRING -
pdf文档密码,如果pdf有密码,需要设置此项
sign_end_date 20 STRING -
签署截止日期,为空不设置,格式为 2010-12-01 00:00:00
signed_custom_user - JSON -
选填项,自定义签署人,无需先创建用户,JSON数组,适用场景可参考官网发起合同或与客服联系
查看示范
[ { "sign_role": "甲方", "sign_name": "姓名", "sign_number": "电话", "sign_company": "选填项,公司名", "seal_require": [ "印章要求" ], "sign_class": 1 } ]
tpl_data - JSON -
选填项,替换模板内的自定义变量后自动生成合同,支持docx格式的模板文件替换,详情请参考<a href="https://oss2.1dq.com/public/模板替换.pdf">模板替换文档</a>
查看示范
{ "自定义参数": "需要替换的内容1", "自定义参数2": "需要替换的内容2" }
tpl_id - STRING -
模板的ID,通过合同文件上传-> 合同模板上传 接口可获得,填写次参数后,file_id 参数为空

请求示范

 POST https://api.1dq.com/v5/Contracts/create.json
 {
    "attachment": "[ { \"file_id\" : \"signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006\", \"file_name\" : \"附件1\" }, { \"file_id\" : \"signed-efb2124360fb5f8b109220e27f99ae35-73ff845c-0006\", \"file_name\" : \"附件2\" } ]",
    "ca_type": "1",
    "channel": "api",
    "copy_custom_user": "[\r\n    {\r\n        \"sign_role\":\"甲方\",\r\n        \"sign_name\":\"姓名\",\r\n        \"sign_number\":\"电话\",\r\n        \"sign_company\":\"选填项,公司名\",\r\n        \"sign_seal_hand\":1,\r\n        \"sign_seal_tpl\":1,\r\n        \"sign_class\":1\r\n    }\r\n]",
    "copy_data": "",
    "deposit_certificate_type": "1",
    "easy_id": "175592531139104768",
    "file_end_date": "",
    "file_id": "signed-ce5858499044c9b8fbbaa272754c145a-108d9e29-0001",
    "name": "项目合同协议",
    "notice_signed": "1",
    "pdf_password": "",
    "sign_end_date": "",
    "signed_custom_user": "[\r\n    {\r\n        \"sign_role\":\"甲方\",\r\n        \"sign_name\":\"姓名\",\r\n        \"sign_number\":\"电话\",\r\n        \"sign_company\":\"选填项,公司名\",\r\n        \"seal_require\":[\"印章要求\"],\r\n        \"sign_class\":1\r\n    }\r\n]",
    "signed_data": "175592531139104768, 175592531139104768",
    "tpl_data": "{\r\n    \"自定义参数\": \"需要替换的内容1\",\r\n    \"自定义参数2\": \"需要替换的内容2\"\r\n}",
    "tpl_id": ""
}

返回结果

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

----words_id

36 STRING 文档唯一Id 54e61bb4-aa5e-11ea-95df-0242ac110004

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "words_id": "54e61bb4-aa5e-11ea-95df-0242ac110004"
    }
}

失败示范

{
    "code": 404,
    "msg": "未找到文件信息",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码