电子印章公共服务平台云端集中用印模式政务网、互联网、兼容标准自建用印模式接入接口定义及示例

附录A

（规范性）

云端集中用印模式政务网接入接口定义及示例

A.1创建个人页面签署

A.1.1接口说明

接口协议:HTTPS协议。

请求方式：POSTo

Content-Type：multipart/foi'm-data;charset=UTF-8。

接口地址：sync/create/pcrsonalo

A.1.2请求消息

请求消息说明见表A」。

表A.1

名称类型是否必填描述

fileFile是pdf/ofd文档(30M限制)

titleString否电子文档名称

personNameSiring是用户姓名

contactString是联系方式，手机号

cardnoString否身份证号，标识用户身份，尽量传入

Base64印章数据（根据contact进行查询，若查询到印章数

sealDataString否据则使用平台内印章，若没查询到印章数据则使用传入的

sealData）

stamperStrString否签署位置预设置，如：[{"x”:0.4,"y":0.4「page”:2}]

needVerifyBoolean否是否需要校验身份，默认true,校验身份

签署成功后的页面跳转地址（前端跳转地址）注意：需添

successPageSiring否

加请求协议

A.1.3签署位置参数(stamperStr)

A.1.3.1根据坐标指定签署位置，参数说明见表A.2：

表A.2

名称类型是否必填描述

印章横坐标占比，左下角为原点（ofd签署时，左上

XDoub1e是

角为原点）

印章纵坐标占比，左下角为原点（ofd签署时，左上

yDouble是

角为原点）

pageDouble是印章签署所在页

参数示例：（文件第一页，X占页宽（）.4,Y占页高0.4处）

［（

"x”:0.4,

y：0.4,

page:1

}］

A.1.3.2根据关键字指定签署位置，参数说明见表A.3。

表A.3

名称类型是否必填描述

keywordString是关键字

offsetXDouble否关键字X坐标偏移量（占页宽比）

offsetYDouble否关键字Y坐标偏移量（占页高比）

关健字索引（关键字在全文出现多次，选择出现的位置，默

keyIndexint否

认】为第一次出现的位置,0为所有关键字出现的位置）

参数示例：（全文搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的

0.1,向下偏移页高长度的0.1

［（

keyword:申万，

“offsetX"：-0.1,

"offset、'"：-0.1,

“keyindex”:2

}］

创建多个签署位置参数示例。

［（

"x”:0.4,

y：0.4,

page:1

},{

keyword:中万，

"offsets〃：-0.1,

"offsetY”:-0.1,

“keyindex”:2

}]

A.1.4响应消息

"code":0,//0：成功，其余失败

“documentld":"2545462971542704132”,〃文档id

"message":"SUCCESS”,〃成功失败信息

〃签署页面地址

}

A.2创建印章页面签署

A.2.1接口说明

接口协议：HTTPS协议。

请求方式：POSTo

Content-Type：multipart/form-data;charset=UTF-8°

接口地址：sync/create/companyo

A.2.2请求消息

请求消息说明见表A.4。

表A.4

名称类型是否必填描述

fileFile是PDF/OFD文档（30M限制）

titleString否电子文档名称

联系方式，手机号，用于签署时校验身份（使用零信任签署

contactString是人工确认时校验方式为确认人手机号，可不传，确认人为

ukey时需要插入ukey确认签署）

stamperStrString否签署位置预设置,如:[{"x":0.4,"y”:0.4,"page":2}]

needVerifyBoolean否是否需要校验身份，默认true,校验身份

successPageString否签署成功后的页面跳转地址（前端跳转地址）

服务端印章编号，可从门户系统获取印章编号，珞式：

1222222222,333333322222（注意:1、0fd签署时，相应印

章需要有对应国办印章

sealidsString否

2、使用零信任接口签署，系统确认，人工确认授权功能的时

候，不支持传入多个不同的印章，且同步签署不支持使用人工

确认方式的印章）

零信任接口签署系统权限校验流水号（与权限校验token同时

serialNumString否

传入）

permissionTokenString否零信任接口签署系统确认权限校验token

A.2.3签署位置参数（stamperStr）

A.2.3.1根据坐标指定签署位置，参数说明见表A.5。

表A.5

名称类型是否必填描述

印章横坐标占比，左下角为原点（ofd签署时，左上

XDouble是

角为原点）

印章纵坐标占比，左下角为原点（ofd签署时，左上

yDouble是

角为原点）

pageDouble是印章签署所在页

参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）

［（

"x”:0.4,

y：0.4,

page:1

｝］

A.2.3.2根据关键字指定签署位置，参数说明见表A.6。

表A.6

名称类型是否必熔描述

keywordString是关键字

offsetXDouble否关键字X坐标偏移量（占页宽比）

offsetYDouble否关键字Y坐标偏移量（占页高比）

关健字索引（关键字在全文出现多次，选择出现的

keyindexint否位置，默认1为第一次出现的位置,0为所有关键字

出现的位置）

参数示例：（全文搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的

0.1,向下偏移页高长度的0.1）

［（

keyword:甲方，

“offsetX”:-0.1,

"offsetY”:-0.1,

“keyindex”:2

｝］

创建多个签署位置参数示例：

［（

"x”:0.4,

"y"：0.4,

page:1

）,（

“keyword":"甲方"，

"offsetX”:-0.1,

"offsetY”:-0.1,

“kcylndcx”:2

}]

A.2.4响应消息

(

"code":0,//0：成功，其余失败

"documentId?，:“2545462971542704132”,〃文档id

"message":"SUCCESS",〃成功失败信息

〃签署页面地址

}

A.3创建ukey页面签署

A.3.1接口说明

接口协议:HTTPS协议。

请求方式：POSTo

Content-Type：multipart/form-data;charset=UTE-8<,

接口地址：sync/create/ukeyo

A.3.2请求消息

请求消息说明见表A.7。

表A.7

名称类型是否必填描述

fileFile是PDF/OFD文档（30M限制）

titleString否电子文档名称

stampers”String否签署位置预设皆,如:[{*x*:0.4,V：0.4.*Daiie*:2}]

successPageString否签署成功后的页面跳转地址（前端跳转地址）

A.3.3签署位置参数stamperStr

A.3.3.1根据坐标指定签署位置，参数说明见表A.8。

表A.8

名称类型是否必填描述

印章横坐标占比，左下角为原点（ofd签署时，左上

XDouble是

角为原点）

印章纵坐标占比，左下角为原点（ofd签署时，左上

yDouble是

角为原点）

pageDouble是印章签署所在页

参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）

[(

x”:0.4,

y〃：0.4,

page:1

}]

A.3.3.2根据关键字指定签署位置，参数说明见表A.9。

表A.9

名称类型是否必填描述

keywordString是关健字

offsctXDouble否关键字X坐标偏移量（占页宽比）

offsetYDouble否关键字Y坐标偏移量（占灾面比）

关键字索引（关键字在全文出现多次，选择出现的

kcylndcxint否位置，默认1为第一次出现的位置,o为所有.关键字

出现的位置）

参数示例：（全文搜索关键字“甲方”，选取第二个“甲方”，并向左偏移页宽长度的

0.1,向下偏移页高长度的0.1）

[（

“keyword":"甲方"，

"offsetX":-0.1,

“offselY":-0.1,

“keyindex”:2

}]

创建多个签署位置参数示例

[（

”4;0.4,

y：0.4,

page:1

},（

"keyword":"甲方"，

“offsetX”:-0.1,

"offsetY”:-0.1,

“keyindex”:2

}]

A.3.4响应消息

（

“code":0,//0：成功，其余失败

“documentld":"2545462971542704132”,〃文档id

"message":"SUCCESS”,〃成功失败信息

〃签署页面地址

}

A.4创建个人静默签署

A.4.1接口说明

接口协议:HTTPS协议。

请求方式：POSTo

Content-Type：multipart/form-data;charset=UTF-8a

接口地址：sync/create/personal/autosign。

A.4.2请求消息

请求消息说明见表A.10。

表A.10

名称类型是否必填描述

fileFile是pdf/ofd文档（30M限制）

titleString否电子文档名称

personNameString是用户姓名

contactString是联系方式，手机号

cardnoString否身份证号，标识用户身份，尽量传入

Base64印章数据（根据conlacl进行查询，若资询到印章数

sealDataString否据则使用平台内印章，若没查询到印章数据则使用传入的

sealData）

stamperStrString是签署位置预设置,如：[{"x":0.4,"y":0.4「page":2}]

A.4.3签署位置参数stamperStr

A.4.3.1根据坐标指定签署位置，参数说明见表A.11。

表A.11

名称类型是否必填描述

印章横坐标口.比，左下角为原点（ofd签署时，左上

XDouble是

角为原点）

印章纵坐标日比，左下角为原点（ofd签署时，左上

yDouble是

角为原点）

pageDouble是印章签署所在页

参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）

[（

"x":0.4,

"y"：0.4,

page:1

}]

A.4.3.2根据关键字指定签署位置，参数说明见A.12。

表A.12

名称类型是否必填描述

keywordString是关键字

offsetXDouble否关犍字X坐标偏移量（占页宽比）

offsetYDouble否关键字Y坐标偏移量（占页高比）

关健字索引（关键字在全文出现多次，选择出现的

keyindexint否位置，默认1为第一次出现的位置,0为所有关键字

出现的位置）

参数示例：（全文搜索关键字“甲方”，选取第二个''甲方”，并向左偏移页宽长度的

0.1,向下偏移页高长度的0.1）

[（

keyword:申万，

“offsetX"：-0.1,

"offsetY":-0.L

“keyIndex”:2

}]

创建多个签署位置参数示例：

[（

"x":0.4,

〃y"：0.4,

page:1

},{

“keyword":"甲方"，

"offsctX”:-0.1,

“ofYselY”:-0.1,

“keyindex”:2

}]

A.4.4响应消息

（

“code":0,//0：成功，其余失败

“documenlld":"2545462971542704132”,//文档id

"message":"SUCCESS”〃成功失败信息

）

A.5创建印章静默签署

A.5.1接口说明

接口协议：HTTPS协议。

请求方式：POSTo

Content-Type：multipart/form-dat<i;charset=UTF-8。

接口地力上：sync/crcate/company/autosign。

A.5.2请求消息

请求消息说明见表A.13。

表A.13

名称类型是否必填描述

fileFile是PDF/0FD文档（30M限制）

titleString否电子文档名称

contactString否联系方式，手机号

签署位置预设置，如：

［（*x*:0.4,*y*:0.4,*page*:2,*sealld*:

stamperStrString是2562988511221907462｝］（使用零信任接口签署，系统确

认，人工确认授权功能的时候,不支持传入多个不同的印

章，且同步签署不支持使用人工确认方式的印章）

零信任接口签署系统权限校验流水号（与权限校验token同

serialNumString否

时传入）

permissionTokenString否零信任接口签署系统确认权限校验token

A.5.3签署位置参数stamperStr

A.5.3.1根据坐标指定签署位置，参数说明见表A.14。

表A.14

名称类型是否必填描述

印章横坐标占比，左下角为原点（ofd签署时，左上角为原

XDouble是

点）

是印章纵坐标占比，左下角为原点（ofd签署时，左上角为原

yDouble

点）

pageDouble是印章签署所在页

签署使用服务端印章编号，可从门户系统获取。（注意：

sealIdLong是

ofd签署时，相应印章需要有对应国办印章）

sealSpecString否修改签署所用印章尺寸，目前仅支持SQIARE_55_55

参数示例：（文件第一页，X占页宽0.4,Y占页高0.4处）

［（

〃x”:0.4,

y：0.4,

page:1,

"sealId”:2562988511221907462

｝］

A.5.3.2根据关键字指定签署位置，参数说明见表A.15。

表A.15

名称类型是否必填描述

keywordString是关键字

印章是否居中，默认为false,按照印章左下角定位，设置

sealCenterBoolean否

为true时印章居中

offsetXDouble否关键字X坐标偏移量（占页宽比）

offsetYDouble否关键字Y坐标偏移量（占页高比）

关键字索引（关键字在全文出现多次，选择出现的位置，

keyIndexini否

默认1为第一次出现的位置,0为所有关健字出现的位置）

sealIdLong是签署使用服务端印章编号，可从门户系统获取。

seaiSpecString否设置签署所用印章尺寸，目前仅支持SQUARE_55_55

参数示例：(全文搜索关键字“甲方”,选取第二个“甲方”，并向左偏移页宽长度的0.1,

向下偏移页高长度的0.1)

[(

“keyword":"甲方"，

“cffset.X”:-0.1,

"offset、'"："0.1,

“keyindex”:2,

“sealId”:2562988511221907462

}]

创建多个签署位置参数示例：

[{

"x":0.4,

y：0.4,

page:1,

“sea11d”:2562988511221907462

},(

keyword:中力，

"offsetX〃：-0.1,

"offsetY”:-0.1,

“keyIndex”:2,

"sealId”:2562988511221907462

}]

A.5.4响应消息

(

"code”:0,//0：成功，其余失败

"documentId":"2545462971542704132”,〃文档id

"message":"SUCCESS”〃成功失败信息

}

A.6下载签署后电子文档

A.6.1接口说明

接口协议：HTTPS协议。

请求方式：GETo

接口地址：document/downloada

A.6.2请求消息

documentld：文档ico

A.6.3响应消息

返回文件流，响应示例：

Content-Disposition:attachment;fileNamo=filc.pdf

Content-Type:multipart/form-data;charset=utf-8

A.7合同状态查询接口

A.7.1接口说明

接口协议：HTTPS协议。

请求方式：GET。

Content-Type：multipart/form-data

接口地址：/contract/status(>

A.7.2请求消息

请求消息说明见表A.16。

表A.16

名称类型是否必填描述

documentldLong毡文档Id

A.7.3响应消息

响应消息说明见表A.17o

表A.17

名称描述

code〃接口响应状态：0为成功其余失败

message成功失败信息

合同状态（COMPLETE,已完成），（EXPIRED,已过期），（DELETE,已删

result

除），（SIGNING,签署中）

“result":"COMPLETE”,

"code”:0,

“message":"SUCCESS”

)

A.8验签

A.8.1接口说明

接口协议：HTTPS协议。

请求方式：POSTo

接口地址:/pdfverifiero

A.8.2请求消息

请求消息说明见表A.18o

表A.18

名称类型是否必填描述

fileFile是本地pdf文档

A.8.3响应消息

响应消息说明见表A.19

表A19

名称描述

ode〃接口响应状态：0为成功其余失败

message成功失败信息

signaturesNum签名数量

hash文档hash值

statusCodc签名校验结果0：文件未被修改1：文件已被修改

statusMsg文件信息

signatureinfosList<SignatureInfo>：签名信息

Signatureinfo说明见A.20。

表A.20

名称描述

msg校验结果

signatory签约人

signTime签约时间

signReason签约原因

organization颁发机构

strAlgName签名算法

signatureCoversWho1eDocument签名是否覆盖全文

hasTimeStamp是否有时间戳

timeStamp如果有时间戳显示时间

verifyTimestamp时间戳校验结果

certDateFrom证书有效期开始

msg校验结果

cerlDateTo证书有效期结束

visibleSignature签名是否可见

imgString签名外观以base64编码

signType签署类型（COMPANY:公章签署;PERSONAL:个人签名）

cardNo证件号码（公章签署为统一社会信用代码，个人签名为身份证号）

msg校验结果

"code”:0,

“slalusMsg〃：〃文件未被修改〃，

“message":"SUCCESS",

“signaturesNum”:2.

"hash”:〃b45co69ca247a82506e5de85f6c536c8”,

“statusCode”:0,

“signatureinfos”:[{

"code”:0,

〃msg”：〃校验成功〃，

"signatory"："测试印章公共服务平台7”,

“signTime":"2019-05-0719:01:16",

“signReason”:〃我同意签署该文件，并承认数字签名的法律效力。

“organization":"SHECAG2(UniTrust)",

"strAlgName":"SHA256”,

“signaturcCovcrsWho1cDocument”:false,

，，hasTimeStamp/z：true,

"timeStamp":"2019-05-0719:01:16”,

，，verifyTimestamp/，:true,

^certDateFrom":"2019-04-1113:53:30”，

"certDateTo":"2019-07-1123:59:59”,

“visibleSignaturc”:true,

"imgString":"data:image/png;base64,iVBORwOKGgoAAAANSU...

“signTyp。"："COMPANY",

“cardNo":"XY139402228301182240”

),

(

"code”:0,

〃msg”:〃校验成功〃，

"signatory":"测试印章公共服务平台7”,

“signTim。"："2019-05-0719:01:16",

“signReasorT:〃我同意签署该文件，并承认数字签名的法律效力。〃，

“organization":"SHECAG2(UniTrust)”,

“strAlgName":"SHA256”,

wsignatureCoversWholeDocument，/:true,

“hasTimcStamp”:true,

“timeStamp"："2019-05-0719:01:16",

“vcrifyTimostamp”:true,

〃certDdteFrom〃：”2019041113:53:30",

"certDateTo":"2019-07-1123:59:59”,

，，visibleSignature，/:true,

"imgString":"data:image/png;base64,iVBORwOKGgoAAAANSUhEU.../z,

"signType":"COMPANY",

〃cardNo〃："XY139402228301182240”

)

]

"fileNam。"："2(7).ofd”,

"code”:0,

"flag":true,

“stalusMsg":"文件未被修改〃，

“signatureinfos”:[

(

"code”:0,

"msg":"校验成功〃，

“signatory"：“测试上海亘岩科技网络有限公司6",

*signTime*:"2020-06-1206:06:13”,

“signatureCoversWholeDocument，/:false,

“hasTimeStamp”:true,

，zverifyTimestampw:true,

"certDateFrom":"2019-10-1411:55:29”，

"certDateTo":"2029-10-1411:55:29",

“visibleSignature”:true,

“imgString":"data:image/png;basc64,iVBORw...

},

(

"code”:0,

〃msg":"校验成功〃，

“signatuy"：“测试上海亘岩科技网络有限公司6〃,

“signTime":"2020-06-1206:06:14",

“signaturcCoversWholeDocumcnt”:false,

“hasTimeStamp”:true,

“vcrifyTimostamp”:true,

“certDateFrom":"2019-10-1411:55:29",

"certDateTo":"2029-10-1411:55:29”,

，，visibleSignature，/:true,

“imgString":"data:image/png;base64,iVBO...”

}

],

“message":"SUCCESS”,

“signaturesNum”:2,

"hash":"7dba4c37bl29405568ad2aaebe44dde9?，,

“statusCode”:0

}

A.9批量验签

A.9.1接口说明

接口协议：HTTPS协议。

请求方式：POSTo

接口地址：/pdfverifier/zip。

A.9.2请求消息

请求消息说明见表A.21。

表A.21

名称类型是否必填描述

fileFile是本地zip压缩文件

A.9.3响应消息

响应消息说明见表A.22。

表A22

名称描述

code接口响应状态：0为成功其余失败

fileNum包含可验证文件个数

message成功失败信息

resultList<AccessResult>PDF验签信息

AccessResult说明见A.23。

表A.23

名称描述

fileNaiiie文件名称

code〃接口响应状态：0为成功其余失败

message成功失败信息

signaturesNum签名数量

hash文档hash值

statusCode签名校验结果0：文件未被修改1：文件已被修

改

statusMsg文件信息

signatureinfosList<Signature】nfo>签名信息

Signatureinfo说明见A.24。

表A.24

名称描述

code校验结果0：校验成功1：校验失败2：未检验

msg校验结果

signatory签约人

signTimc签约时间

signReason签约原因

organization颁发机构

strAlgName签名算法

signatureCoversWholcDocument签名是否覆盖全文

hasTimeStamp是否有时间戳

timeStamp如果有时间戳显示时间

verifyTimestamp时间戳校验结果

ccrtDatcFrom证书有效期开始

certDateTo证书有效期结束

visibleSignature签名是否可见

imgString签名外观以ba$e64编码

signTypc签署类型（COMPANY:公章签署；PERSONAL:个人签名）

cardNo证件号码（公章签署为统一社会信用代码，个人签名为身份证号）

"code”:0,

“fileNunT:2,

“mossagc":"SUCCESS”,

“result”:[{

“fileName":〃文件.pdf”,

"code":0,

"flag":true,

"statusMsg":"文件未被修改”,

“signatureinfos”:[{

"code”:0,

"msg”:〃校验成功”，

“signatory":“文U威〃，

"signTime”:*2019-05-0814:15:31”,

〃signReason〃：“我同意签署该文件，并承认数字签名的法律效力。

“organization":"SHECARapid(UniTrust)，z,

"strAlgName":"SHA256”,

signaturcCoversWho1oDocumcntz，:false,

“hasTimeStamp”:true,

“timcStamp":"2019-05-0814:15:31",

，/verifyTimestamp/，:true,

"certDateFrom":"2019-05-0814:15:28”,

,，certI)ateTo/，:"2019-05-0814:25:28”,

z，visibleSignature，z：true,

“imgString":"data:image/png;base64,iVBOR…”，

"signType":"PERSONAL",

“cardNo":

“code”:(),

"msg":"校验成功”,

"signatory”:〃测试印章公共服务平台9〃，

"signTime”:*2019-05-0814:18:26”,

“signReason”:〃我同意签署该文件，并承认数字签名的法律效力”,

“organization":"SHECAG2(UniTrust)”,

“strAlgName":"SHA256”,

“signalureCoversWholeDocumenl”:true,

“hasTimeStamp”:true,

"timeStamp":"2019-05-0814:18:26”,

“vBrifyTimestamp”:true,

"certDateFrom":z，2019-04-1113:58:35”,

"certDateTo”:〃2019-07-1123:59:59〃，

“visibleSignature”:true,

，，imgString，z："data:image/png;base64,iVBORwOKG...，z,

"signType":"COMPANY”,

“cardNo”:〃XY139402228301182630”

)

],

“message":"SUCCESS”,

*signaturesNumw:2,

"hash":"0「9c762a】lf8442e63fc4「4253cd05e6”,

“statusCod。“：0

},

(

“filcNamc":"新建.pdf”,

“code”:0,

"flag":true,

"statusMsg":〃文件未被修改”，

“signatureinfos”:[{

"code”:0,

"msg”:〃校验成功”，

"signatory":"刘威",

“signTime":"2019-05-0814:15:31",

“signRoason”:〃我同意签署该文件，并承认数字签名的法律效力。

“organization":"S11ECARapid(UniTrust)

“strAlgName":"SHA256”,

“signatureCoversKholeDocument”:false,

“hasTimeStamp”:true,

^timeStamp":"2019-05-0814:15:31”,

，，verifyTimestamp，/：true,

“certDateFroni":"2019-05-0814:15:28”,

“certDateT。"："2019-05-0814:25:28”,

“visibleSignature”:true,

"imgSiring":"data:image/png;base64,iVIJOKwOKG...，z,

"signType":"PERSONAL”,