关键字定位坐标

更新时间：2022-03-01 11:26:16

文档变更

2022年时，搜索关键字坐标变为关键字定位坐标，仅中文名称变更，其功能保持不变。

接口描述

搜索PDF文件中关键字的坐标，以关键字左下角为原点去查询坐标。

注意：扫描或图片生成的PDF文件无法检索关键字。

接口地址&请求方式

接口地址：/v1/documents/{fileId}/searchWordsPosition

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称

类型

必选

参数类型

参数说明

fileId

string

是

path

文档ID

keywords

string

是

query

关键字列表，逗号分割；注意要英文的逗号，不能中文逗号；关键字建议不要设置特殊字符，因Adobe无法识别部分符号，某些特殊字符会因解析失败从而导致搜索不到。

注意：扫描或图片生成的PDF文件无法检索关键字。

公共响应参数

参数名称	类型	必选	参数说明
code	int	是	业务码，0表示成功
message	string	否	业务信息
data	array	否	业务数据

响应参数

展开全部参数参数名称			类型	必选	参数说明
fileId			string	否	文档ID
keyword			string	否	关键字
positionList			array	否	位置列表
	pageIndex		int	否	页码
	coordinateList		array	否	坐标信息
	posx	float	否	x坐标
	posy	float	否	y坐标

请求示例

GET https://openapi.esign.cn/v1/documents/{fileId}/searchWordsPosition?keywords=keyword1,keyword2

响应示例

{
  "code": 0,
  "message": "成功",
  "data": [
    {
      "keyword": "方法",
      "fileId": "b4f3d89420ec438ab83e8a02cabf1342",
      "positionList": [
        {
          "pageIndex": 1,
          "coordinateList": [
            {
              "posx": 315.43,
              "posy": 185.65723
            }
          ]
        }
      ]
    }
  ]
}