电子签章
最近更新时间: 2025年06月13日 06时54分40秒
能力接口
描述
对合同附件进行在线电子签章
注意事项
电子签章接口是异步接口,不会直接返回签章合同信息,会返回taskId,拿到taskId后调用获取文件接口,可以获取签章后的文件下载地址
支持的模式
授权码模式,客户端模式
请求方法
POST
请求地址
https://api.tongji.edu.cn/v1/infra/electronic_signature/seal
请求体参数
参数名 | 类型 | 是否必须 | 备注 |
---|---|---|---|
exampleInfos | object[] | 是 | 实例合同集合 |
docName | string | 是 | 合同名称 |
relDocId | string | 是 | 合同业务关联Id |
watermarkState | string | 否 | 是否添加水印(ENABLE/DISABLE 不传参数默认为DISABLE ) |
fileInfos | object[] | 是 | 文件集合 |
fileDownloadAddress | string | 是 | pdf下载地址(可直接下载的url地址) |
order | string | 是 | 文件序号(1,2,3) |
signatories | object[] | 是 | 签署方集合 |
acrossAxisInfos | object[] | 否 | 骑缝章集合 |
crossSealHeight | int | 否 | 骑缝章高度(取值0-1000 不传参数默认为500) |
startPageNo | int | 是 | 开始页码(startPageNo和endPageNo同时为0表示PDF所有页,否则必须大于0且endPageNo>startPageNo) |
endPageNo | int | 是 | 结束页码(逻辑约束同startPageNo) |
skipPage | boolean | 否 | 是否跳页加盖(true/false 不传参数默认为false ) |
leftSide | boolean | 否 | 是否是左骑缝(true/false 不传参数默认为false) |
sealType | string | 是 | 签章类型(开通权限后由信息办提供) |
axisInfo | object[] | 否 | 坐标集合 |
fieldX | float | 否 | 横坐标(取值0-1 不传参数默认为0) |
fieldY | float | 否 | 横坐标(取值0-1 不传参数默认为0) |
pageNum | int | 是 | 页码(0为所有页盖章) |
sealType | string | 是 | 签章类型(开通权限后由信息办提供) |
signatoryType | string | 是 | 签署方类型 ENTERPRISE-企业,ORG-部门 |
enterpriseSignatory | object | 是 | 企业签署方信息 |
orgId | string | 是 | 部门编码(人事处部门编码,企业章为00) |
keywordInfo | object[] | 否 | 关键字集合 |
heightMoveSize | int | 否 | 上下偏移量(正数向上偏移,负数向下偏移 不传参数默认为0) |
index | int | 否 | 关键字索引(0表示所有关键字,正数表示第n个,负数表示倒数第n个 不传参数默认为1) |
keyword | string | 是 | 关键字 |
moveSize | int | 否 | 左右偏移量(正数向右偏移,负数向左偏移 不传参数默认为0) |
moveType | string | 否 | 覆盖类型(1-覆盖关键字;2-关键字右侧;3-关键字下方 不传参数默认为1) |
sealType | string | 是 | 签章类型(开通权限后由信息办提供) |
watermarkVO | object | 否 | 水印设置(watermarkState为ENABLE时候必填) |
fontSize | int | 否 | 字体大小(10-28 不传参数默认为10) |
opacity | float | 否 | 透明度(0-100 不传参数默认为50) |
ratation | float | 否 | 旋转角度(0-360 不传参数默认为0) |
text | string | 是 | 水印内容 |
signatoryOrders | object[] | 是 | 签署方排序 |
orderNum | string | 是 | 签署方排序编号 |
orgId | string | 是 | 部门编码(人事处部门编码,企业章为00) |
signatoryType | string | 是 | 签署方类型 ENTERPRISE-企业,ORG-部门 |
返回参数
参数名 | 类型 | 备注 | 码表 |
---|---|---|---|
code | string | 返回码 | |
msg | string | 返回信息 | |
data | object[object] | 结果信息 | |
taskId | string | 任务ID |
解释说明
1.签章类型
开通权限后由信息办提供
2.企业章和部门章如何传参
企业章
signatoryOrders.signatoryType 设置 ENTERPRISE
signatoryOrders.orgId 设置 00
enterpriseSignatory.orgId 设置 00
signatories.signatoryType 设置 ENTERPRISE
部门章
signatoryOrders.signatoryType 设置 ORG
signatoryOrders.orgId 设置 人事处部门编码
enterpriseSignatory.orgId 设置 人事处部门编码
signatories.signatoryType 设置 ORG
3.请求示例说明
请求示例包含了坐标章、关键字章、骑缝章、添加水印这四个功能,可根据请求体参数说明自行 删减字段。
坐标章:根据横坐标和纵坐标的位置进行签章
关键字章: 在文字里查找关键字的位置进行签章
骑缝章:在多个页文件的相邻边缘处进行签章
坐标章、关键字章、骑缝章三个是非必填项,但是请求时候必须传递一个。
请求示例
{
"exampleInfos": [
{
"docName": "文件名称",
"relDocId": "123",
"watermarkState": "ENABLE",
"fileInfos": [
{
"fileDownloadAddress": "https://xxxxxxxx?fileName=xxx.pdf",
"order": "1"
}
],
"signatories": [
{
"acrossAxisInfos": [
{
"crossSealHeight": 500,
"endPageNo": 0,
"leftSide": true,
"sealType": "CONTRACT_SEAL",
"skipPage": false,
"startPageNo": 0
}
],
"axisInfo": [
{
"fieldX": 1,
"fieldY": 1,
"pageNum":1,
"sealType": "CONTRACT_SEAL"
}
],
"signatoryType": "ENTERPRISE",
"enterpriseSignatory": {
"orgId": "00"
},
"keywordInfo": [
{
"heightMoveSize": 0,
"index": 1,
"keyword": "关键字",
"moveSize": 0,
"moveType": "1",
"sealType": "OFFICIAL_SEAL"
}
]
}
],
"watermarkVO": {
"fontSize": 12,
"opacity": 50,
"ratation": 0,
"text": "同济"
}
}
],
"signatoryOrders": [
{
"orderNum": "1",
"orgId": "00",
"signatoryType": "ENTERPRISE"
}
]
}
返回示例
{
"code": "A00000",
"data": {
"taskId": "c6c86b01*****************"
},
"msg": "操作成功"
}