基础介绍
当合同需要双方签署时，例如：销售合同、劳动合同、租赁合同、采购合同等等需要双方签字/盖章的场景可以参考本流程。其中发起签署前的合同的生成可以参考《生成合同》模块。
效果展示
用户签署操作页面效果：点击查看 SaaS API V3版用户签署页操作手册
用户签署操作视频演示：签署演示视频.mp4
双方签署后效果展示：
测试文件下载：软件销售合同 .docx
API列表
API接口（点击直接跳转相关API文档） | API描述 | 是否必需 |
此接口用来发起签署，发起成功后会返回签署流程标识：signFlowId。 | 必需 | |
此接口获取签署方签署页面链接，可用于签署或预览。 | 按需 | |
此接口可以根据发起签署接口返回的signFlowId，来查询签署状态、签署配置等信息。 | 按需 | |
此接口可在签署流程结束后，下载签署后的PDF文件以及其他查看类附件。 | 建议 |
基于文件发起签署接口代码案例
因基于文件发起签署接口是发起签署必需接口，参数较多，不同的场景容易弄混。所以列举以下关键参数以及常用传参案例以供参考。
关键参数
- signerType（签署方类型，0 - 个人，1 - 机构，2 - 法定代表人）
- psnSignerInfo（个人签署方信息）
- orgSignerInfo（机构签署方信息）自动签署场景，建议不传此对象，e签宝后台会取默认值
- autoSign（是否后台自动落章）
- signOrder（设置签署方的签署顺序，按序签时传入顺序值 1 - 255，不需要顺序签可以指定相同顺序值，或者不指定该参数）
平台自身和个人用户签署案例
- 签署方1（平台自身）：当 autoSign 设置为：true（后台自动签署），e签宝后台会自动获取当前appid所属公司的信息、印章，所以可以不传入签署方信息；平台属于机构类型，所以 signerType 设置为：1 （机构）；签署顺序 signOrder 设置为：1（顺序值小的数字先签署）。
- 签署方2（个人用户）：psnSignerInfo 传入个人用户的身份信息；个人用户属于个人类型，所以 signerType 设置为：0（个人）；签署顺序 signOrder 设置为：2（顺序值大的数字后签署）。
{
"docs": [
{
"fileId": "请设置待签署文件的fileId",
"fileName": "请设置待签署文件的文件名称.pdf"
}
],
"signFlowConfig": {
"signFlowTitle": "请设置当前签署任务的主题：此场景演示平台自身、个人用户双方签署",
"autoFinish": true,
"noticeConfig": {
"noticeTypes": "1,2"
},
"notifyUrl": "请设置异步回调地址，以http/https开头",
"redirectConfig": {
"redirectUrl": "请设置重定向跳转地址，例如：https://www.esign.cn/"
}
},
"signers": [
{
"signConfig": {
"signOrder": 1
},
"signerType": 1,
"signFields": [
{
"customBizNum": "自定义编码001",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"autoSign": true,
"signFieldStyle": 1,
"signFieldPosition": {
"positionPage": "3",
"positionX": 200,
"positionY": 200
}
}
}
]
},
{
"psnSignerInfo": {
"psnAccount": "请设置个人用户的手机号/邮箱",
"psnInfo": {
"psnName": "个人用户的姓名"
}
},
"signConfig": {
"forcedReadingTime": 10,
"signOrder": 2
},
"signerType": 0,
"signFields": [
{
"customBizNum": "自定义编码002",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"signFieldPosition": {
"positionPage": "3",
"positionX": 480,
"positionY": 200
},
"signFieldStyle": 1
}
}
]
}
]
}平台自身和企业用户签署案例
- 签署方1（平台自身）：当 autoSign 设置为：true（后台自动签署），e签宝后台会自动获取当前appid所属公司的信息、印章，所以可以不传入签署方信息；平台属于机构类型，所以 signerType 设置为：1 （机构）；签署顺序 signOrder 设置为：1（顺序值小的数字先签署）。
- 签署方2（企业用户）：orgSignerInfo 传入企业用户的身份信息；企业用户属于机构类型，所以 signerType 设置为：1 （机构）；签署顺序 signOrder 设置为：2（顺序值大的数字后签署）。
{
"docs": [
{
"fileId": "请设置待签署文件的fileId",
"fileName": "请设置待签署文件的文件名称.pdf"
}
],
"signFlowConfig": {
"signFlowTitle": "请设置当前签署任务的主题：此场景演示平台自身、企业用户双方签署",
"autoFinish": true,
"noticeConfig": {
"noticeTypes": "1,2"
},
"notifyUrl": "请设置异步回调地址，以http/https开头",
"redirectConfig": {
"redirectUrl": "请设置重定向跳转地址，例如：https://www.esign.cn/"
}
},
"signers": [
{
"signConfig": {
"signOrder": 1
},
"signerType": 1,
"signFields": [
{
"customBizNum": "自定义编码001",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"autoSign": true,
"signFieldStyle": 1,
"signFieldPosition": {
"positionPage": "3",
"positionX": 200,
"positionY": 200
}
}
}
]
},
{
"orgSignerInfo": {
"orgName": "请设置企业用户企业名称",
"orgInfo": {
"orgIDCardNum": "请设置企业用户的统一社会信用代码",
"orgIDCardType": "CRED_ORG_USCC"
},
"transactorInfo": {
"psnAccount": "请设置企业用户经办人的手机号",
"psnInfo": {
"psnName": "个人用户的姓名"
}
}
},
"signConfig": {
"forcedReadingTime": 10,
"signOrder": 2
},
"signerType": 1,
"signFields": [
{
"customBizNum": "自定义编码001",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"signFieldStyle": 1,
"signFieldPosition": {
"positionPage": "3",
"positionX": 200,
"positionY": 200
}
}
}
]
}
]
}企业用户和个人用户签署案例
- 签署方1（企业用户）：orgSignerInfo 传入企业用户的身份信息；企业用户属于机构类型，所以 signerType 设置为：1 （机构）；签署顺序 signOrder 设置为：1（顺序值小的数字先签署）。
- 签署方2（个人用户）：psnSignerInfo 传入个人用户的身份信息；个人用户属于个人类型，所以 signerType 设置为：0（个人）；签署顺序 signOrder 设置为：2（顺序值大的数字后签署）。
{
"docs": [
{
"fileId": "请设置待签署文件的fileId",
"fileName": "请设置待签署文件的文件名称.pdf"
}
],
"signFlowConfig": {
"signFlowTitle": "请设置当前签署任务的主题：此场景演示企业用户、个人用户双方签署",
"autoFinish": true,
"noticeConfig": {
"noticeTypes": "1,2"
},
"notifyUrl": "请设置异步回调地址，以http/https开头",
"redirectConfig": {
"redirectUrl": "请设置重定向跳转地址，例如：https://www.esign.cn/"
}
},
"signers": [
{
"orgSignerInfo": {
"orgName": "请设置企业用户企业名称",
"orgInfo": {
"orgIDCardNum": "请设置企业用户的统一社会信用代码",
"orgIDCardType": "CRED_ORG_USCC"
},
"transactorInfo": {
"psnAccount": "请设置企业用户经办人的手机号",
"psnInfo": {
"psnName": "个人用户的姓名"
}
}
},
"signConfig": {
"forcedReadingTime": 10,
"signOrder": 1
},
"signerType": 1,
"signFields": [
{
"customBizNum": "自定义编码001",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"signFieldStyle": 1,
"signFieldPosition": {
"positionPage": "3",
"positionX": 200,
"positionY": 200
}
}
}
]
},
{
"psnSignerInfo": {
"psnAccount": "请设置个人用户的手机号/邮箱",
"psnInfo": {
"psnName": "个人用户的姓名"
}
},
"signConfig": {
"forcedReadingTime": 10,
"signOrder": 2
},
"signerType": 0,
"signFields": [
{
"customBizNum": "自定义编码002",
"fileId": "请设置待签署文件的fileId",
"normalSignFieldConfig": {
"signFieldStyle": 1,
"signFieldPosition": {
"positionPage": "3",
"positionX": 480,
"positionY": 200
}
}
}
]
}
]
}
我要纠错