自动签署
简要描述
自动签署
请求地址
/v4/api/fdd/operateExtSignAutoHeader
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| Token | 是 | string | 应用令牌 |
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| transactionId | 是 | string | 1 | 交易号 | FDDXXXXXXXXXXX |
| contractId | 是 | string | 1 | 合同编号 | HT202605260001 |
| customerId | 是 | string | 1 | 客户编号 | 3E4B4CXXXX |
| clientRole | 否 | string | 1 | 代理人客户编号 | |
| docTitle | 是 | string | 1 | 文档标题 | 运输合同 |
| positionType | 否 | string | 1 | 定位类型 0-关键字（默认） 1-坐标 | 0 |
| extraSignData | 否 | string | 1 | 日期章定位参数 position_type=0-关键字定位示例：{"signKeyword":"日期","keywordStrategy": 1,"keyx":"-80","keyy":"-60"}；position_type=1坐标定位示例：{"signaturePositions":[{"pagenum":"0","x":"181","y":"132"}]}。注意事项：仅签署后的PDF文件展示日期章效果、需联系法大大同事开通SVG格式印章 | |
| signKeyword | 否 | string | 1 | 定位关键字 关键字为文档中的文字内容（要能使用ctrl+f搜索到）。法大大按此关键字进行签章位置的定位，将电子章盖在这个关键字上面。凡出现关键字的地方均会盖上指定用户的电子章，建议关键字在合同中保持唯一。 | 甲方签字 |
| keywordStrategy | 否 | string | 1 | 关键字签章策略 0：所有关键字签章（默认）；1：第一个关键字签章；2：最后一个关键字签章 | 0 |
| searchIndex | 否 | string | 1 | 指定第N个关键字 多个值用英文逗号分隔，例：1,8,12。当keyword_strategy=3时必传。N超出总关键字数部分不处理，只对有效值盖章 | |
| signaturePositions | 否 | array | 1 | 定位坐标 | |
| pagenum | 否 | string | 2 | 页码 签章页码，从 0开始。即在第一页签章，传值 0 | 0 |
| x | 否 | string | 2 | 盖章点x坐标 以左上角为原点（0.0），取鼠标位置为图片中心点；坐标请以图片宽度为 800 为基准 | 181 |
| y | 否 | string | 2 | 盖章点y坐标 以左上角为原点（0.0），取鼠标位置为图片中心点 坐标请以图片高度为 1131 为基准 | 132 |
| signatureId | 否 | string | 1 | 印章编号 调新增签章接口返回 | SEALXXXXXXXXXX |
| notifyUrl | 否 | string | 1 | 签署结果异步通知URL 如果指定，当签章完成后，法大大将向此URL发送签署结果。notify_url最大长度为500 | https://xxx/notify |
| signatureShowTime | 否 | string | 1 | 时间戳显示方式 不传默认为1 1：以后台配置为准，如果存在部分签署显示、部分签署不显示的场景，需要配置显示时间戳，以及时间戳显示样式 2：不显示时间戳 | 1 |
| keyx | 否 | string | 1 | 关键字偏移量，偏移x位置 [-595,595]之间的数字 | -80 |
| keyy | 否 | string | 1 | 关键字偏移量，偏移y位置 [-842,842]之间的数字 | -60 |
入参示例
json
{
"transactionId": "FDDXXXXXXXXXXX",
"contractId": "HT202605260001",
"customerId": "3E4B4CXXXX",
"docTitle": "运输合同",
"positionType": "0",
"signKeyword": "甲方签字",
"keywordStrategy": "0",
"signatureId": "SEALXXXXXXXXXX",
"notifyUrl": "https://xxx/notify"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
| downloadUrl | string | 2 | 下载合同链接 |
| viewpdfUrl | string | 2 | 查看合同链接 |
成功返回示例
json
{
"code": 200,
"msg": "业务处理成功",
"data": {
"downloadUrl": "https://xxx/download",
"viewpdfUrl": "https://xxx/viewpdf"
},
"total": null,
"requestId": "ef1945c"
}失败返回示例
json
{
"code": 500,
"msg": "业务处理失败",
"data": null,
"total": null,
"requestId": "661df7a1"
}