接口描述
检索PDF文件中所含关键字的所有XY坐标信息。
请求说明：
（1）适用于通过查找关键字的所在位置，来定位需要加盖印章（签名）的坐标。
（2）仅适用文本类内容的PDF文件，通过扫描或图片生成的PDF文件无法查询关键字坐标。
为方便接口开发，该接口于2023年3月20日新增POST请求方式。
原有GET请求方式仍然保留，但因为请求头的签名计算涉及到URL编码问题，不够便捷不再推荐。
新接口地址&请求方法（推荐）
接口地址：https://{host}/v3/files/{fileId}/keyword-positions
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
fileId | string | 是 | path | 文件ID（文件需要提前上传到e签宝服务端，文件上传接口：上传本地文件） |
keywords | list | 是 | body | 关键字列表，能够通过该值定位到在文件中的位置坐标。 补充说明： （1）允许一次查找多个关键字，请使用英文逗号分隔； （2）关键字不支持特殊字符、符号等Adobe无法解析的字符； |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message匹配，因为 message 可能会调整。 | ||||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||||
keywordPositions（点击“+”展开详情） | array | 否 | 关键字信息 | ||||
keyword | string | 否 | 关键字 | ||||
searchResult | boolean | 否 | 关键字是否检索到坐标值 | ||||
positions（点击“+”展开详情） | array | 否 | 关键字位置信息 注：计算的是关键字第一个字的左下角坐标位置，例如：关键字是“甲方盖章处”，那么坐标值就是“甲”的左下角位置。 | ||||
pageNum | int32 | 否 | 关键字所在页码 | ||||
coordinates | array | 否 | 关键字XY坐标值 | ||||
positionX | float | 否 | X坐标 | ||||
positionY | float | 否 | Y坐标 | ||||
请求示例
{
"keywords": [
"甲方盖章/签字",
"乙方盖章/签字"
]
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"keywordPositions": [
{
"keyword": "甲方盖章/签字",
"searchResult": true,
"positions": [
{
"pageNum": 3,
"coordinates": [
{
"positionX": 90.0,
"positionY": 190.611
}
]
}
]
},
{
"keyword": "乙方盖章/签字",
"searchResult": true,
"positions": [
{
"pageNum": 3,
"coordinates": [
{
"positionX": 351.24,
"positionY": 190.611
}
]
}
]
}
]
}
}错误码
接口地址&请求方法（不推荐）
接口地址：https://{host}/v3/files/{fileId}/keyword-positions?keywords=关键字1,关键字2
请求方法：GET
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
fileId | string | 是 | path | 文件ID |
keywords | string | 是 | query | 关键字列表，能够通过该值定位到在文件中的位置坐标。 补充说明： （1）允许一次查找多个关键字，请使用英文逗号分隔； （2）关键字不支持特殊字符、符号等Adobe无法解析的字符； |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message匹配，因为 message 可能会调整。 | ||||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||||
keywordPositions（点击“+”展开详情） | array | 否 | 关键字信息 | ||||
keyword | string | 否 | 关键字 | ||||
searchResult | boolbean | 否 | 关键字是否检索到坐标值 | ||||
positions（点击“+”展开详情） | array | 否 | 关键字位置信息 | ||||
pageNum | int32 | 否 | 关键字所在页码 | ||||
coordinates | array | 否 | 关键字XY坐标值 | ||||
positionX | float | 否 | X坐标 | ||||
positionY | float | 否 | Y坐标 | ||||
请求示例
GET https://openapi.esign.cn/v3/files/061778***701b7/keyword-positions?keywords=甲方响应示例
{
"code": 0,
"message": "成功",
"data": {
"keywordPositions": [
{
"keyword": "甲方",
"searchResult": true,
"positions": [
{
"pageNum": 1,
"coordinates": [
{
"positionX": 90.024,
"positionY": 756.791
},
{
"positionX": 111.144,
"positionY": 756.791
}
]
}
]
}
]
}
}
我要纠错