获取拖章定位页面

更新时间:2024-10-16 18:41:26

接口描述

开发者将文件上传至e签宝服务端后获取到文件ID(PDF文件),通过该文件ID获取e签宝的拖章定位页面,设置好位置后,开发者可以在 回调通知:获取签章位置信息通知 中接收位置坐标等信息,用于后续基于文件发起签署接口的辅助定位。页面样式如下:

新接口地址&请求方法

接口地址:https://{host}/v3/files/get-seal-position-url

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

customBizNum

string

body

自定义业务编码(开发者自定义业务标识,定位后在回调通知中原样返回,可以区分具体是哪笔业务流程)

点击跳转 回调通知:获取签章位置信息通知

fileId

string

body

文件ID(文件需要提前上传到e签宝服务端,文件上传接口:上传本地文件

signerRoles

list

body

签署方角色标识,用于关联签署区(可以自定义命名,如:甲方签署区、乙方签署区等)

补充说明:

  • 该字段主要为了区分不同的签署方的位置坐标
  • 在同一次请求里,签署方角色标识不可以重复

redirectUrl

string

body

定位完成后提交跳转的页面重定向跳转地址(需符合 https /http 协议地址)

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据

getSealPositionUrl

string

拖章定位页面链接(该地址有效期一天,保存一次后失效)

请求示例

{
    "customBizNum": "自定义编码001",
    "fileId": "70a0b2e887101111156969f79535bb",
    "signerRoles": [
        "甲方签署区",
        "乙方签署区"
    ],
    "redirectUrl": "https://esign.cn"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "getSealPositionUrl": "https://smlfront.esign.cn:8880/template/seal-position?appId=7438111954&bizId=f1cc883a42934c511a975777cd41f9de&encryption=pyHNNMf3eEjqXnKErwsECyY%2BWDaMlFJ9%2BXUJfqRR2T1hibA3XV8yfWC6nG1hLo/9XcbIN7XcjN9qof%2BGCHJdbadA6%2B0pFZPP8goi9/QMrQ7zL3%2B6TkrxlugSBvdAFFup%0A&scene=api_seal_position&redirectUrl=https://esign.cn"
    }
}

错误码

点击查看错误码

我要纠错