根据关键字获取坐标

POST /esignglobal/v1/files/keywordPositions

接口描述

使用API发起信封前，可通过本接口来获取指定内容在文件上的坐标，作为发起信封接口的入参，搜索的范围为整个文档。

请求参数

参数名称

类型

必填

说明

fileKey

string

true

文件fileKey

keywords

array

true

关键字列表，能够通过该值定位到在文件中的位置坐标

【注意】

一次最多传入5个关键字。
关键字不支持特殊字符、emoji等Adobe无法解析的字符。

请求示例

{
    "keywords": [
    "制单人：",
    "打印日期："
  ],
    "fileKey": "$dd863699-e1ba-47ba-b05c-26029e7089f9$793468458"
}

响应参数

参数名称				类型	说明
keywordPositions				array	关键字信息
	keyword			array	关键字
	searchResult			boolean	关键字是否检索到坐标值
		positions		array	关键字位置信息
		pageNum		int	关键字所在页码
		coordinates		array	关键字XY坐标值【注意】坐标定位按照关键字第一个字进行定位，并且坐标数组按照 Y 坐标降序，再按照 X 坐标升序排列
			positionX	float	X坐标
			positionY	float	Y坐标

响应示例

{
    "code": "0",
    "data": [
    {
      "keyword": "制单人：",
      "positions": [
        {
          "coordinates": [
            {
              "positionX": 174,
              "positionY": 361.27
            }
          ],
          "pageNum": 2
        }
      ],
      "searchResult": true
    },
    {
      "keyword": "打印日期：",
      "positions": [
        {
          "coordinates": [
            {
              "positionX": 804,
              "positionY": 361.77
            }
          ],
          "pageNum": 2
        }
      ],
      "searchResult": true
    }
  ],
    "message": "成功"
}