追加自动签署区

文档变更

2022年时，添加签平台方自动盖章签署区变为追加自动签署区，以便开发者更容易理解，仅中文名称变更，其功能保持不变。无特殊说明时，文档其他地方及参数中的【签署区】字样等同于【签章区】。

接口描述

向指定流程中创建签署区，每个签署区视为一个任务，系统会自动按照流程流转。签署区的添加必须在签署文档添加之后, 签署区信息内部包含签署文档信息（平台自动签无需指定签署人信息，默认签署人是对接的企业）。

签署区创建完成，流程开启后，系统将自动完成“对接平台自动盖章签署区”的盖章，对接平台可全程无感完成本次签署。

接口地址&请求方式

接口地址：/v1/signflows/{flowId}/signfields/platformSign

请求方式：POST

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

展开全部参数参数名称			类型	必选	参数类型	参数说明（左右拖动查看完整描述）
flowId			string	是	path	签署流程ID
signfields			array	是	body	签署区列表数据
	fileId		string	是	body	文件fileId
	order		int32	否	body	签署顺序，默认1,且不小于1，顺序越小越先处理
	posBean		object	是	body	签署区位置信息, （signType为1时, 页码和XY坐标不能为空, signType为2时, 页码和Y坐标不能为空）
		posPage	string	是	body	页码信息，当签署区signType为2时, 页码可以'-'分割, 传all代表盖全部页码；其他情况只能是数字
		posX	float	否	body	x坐标，默认空
		posY	float	是	body	y坐标
		width	float	否	body	签署区宽，默认印章宽度
		addSignTime	boolean	否	body	签章日期，默认跟随在印章底部，默认false。 true-显示日期 false-不显示日期
signTimeFormat		string	否	body	签章日期格式，yyyy-MM-dd HH:mm:ss
signDateBeanType		int 32	否	body	是否需要添加签署日期，0-禁止 1-必须 2-不限制，默认0
signDateBean		Object	否	body	签章日期信息
	fontSize	int32	否	body	签章日期字体大小,默认12
	format	string	否	body	签章日期格式，yyyy年MM月dd日
	posPage	int32	否	body	页码信息，当signDateBeanType为1时，签章日期默认展示在签署页面左下角位置，如需指定日期盖章位置，则需传入日期盖章页码和坐标（日期页码与印章页码需相同）
	posX	float	否	body	x坐标，默认0（如果X和Y坐标不传入，签章日期展示在签署页左下角）
	posY	float	否	body	y坐标，默认0（如果X和Y坐标不传入，签章日期展示在签署页左下角）
sealId		string	否	body	印章ID 仅限企业章，暂不支持指定企业法定代表人印章注：（1）当印章ID为空时，取appId对应企业的默认印章；（2）如果指定企业授权印章，签署后的签名信息，印章样式和数字证书均为授权企业主体所有，详细参考【印章授权说明】
signType		int32	否	body	签署类型， 1-单页签署，2-骑缝签署，默认1
thirdOrderNo		string	否	body	第三方流水号注： 1.该字段属于自定义内容，传入的内容会在后续【签署人签署完成回调通知】以及【查询签署区列表】【流程签署人列表】接口中原样返回。可以通过该字段的传值标识自己的业务以及签署方信息。 2.须保证同流程中相同签署人、相同签约主体、相同签署顺序的任务，对应的该字段值唯一举例：N001-15300001111（自己的标识+手机号）

响应参数

展开全部参数参数名称			类型	必选	参数说明（左右拖动查看完整描述）
code			int	是	业务码，0表示成功
message			string	否	业务信息
data			object	否	业务数据
	signfieldBeans		array	否	签署区列表数据
	accountId	string	否	用户ID
	fileId	string	否	文档ID
	signfieldId	string	否	签署区ID

请求示例

POST https://openapi.esign.cn/v1/signflows/{flowId}/signfields/platformSign

{
    "signfields":[
        {
            "fileId":"fe7df2f477d649c18ebcfdfffeba253d",
            "order":1,
            "posBean":{
                "posPage":"1",
                "posX":158.72531,
                "posY":431.05658
            },
            "sealId":"bcd7ffd9-5caf-4342-bd1c-02257229ccd5",
            "signType":1
        }
    ]
}

响应示例

{
    "code":0,
    "data":{
        "signfieldBeans":[
            {
                "accountId":"2c7de24aff3340f5b944ebac49545b8e",
                "fileId":"fe7df2f477d649c18ebcfdfffeba253d",
                "signfieldId":"b76b69d5b48d4f689cae997e42809ac4"
            }
        ]
    },
    "message":"成功"
}

错误码

错误码	错误描述	排查方法（左右拖动查看完整描述）
1437511	文档不存在，fileId:XXX	签署区里的fileId为空或fileId无效
1437306	XXXX:签署页码超出文档页数	签署区的页码大于文档页数
1435002	未定义的signType	签署类型无效, signType仅支持： 0-不限, 1-单页签署, 2-骑缝签
401		1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的