根據關鍵字獲取坐標

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": "成功"
}