Центр разработчиков

Получить координаты по ключевому слову

POST /esignglobal/v1/files/keywordPositions

Описание интерфейса

Перед отправкой конверта с использованием API вы можете использовать этот интерфейс, чтобы получить координаты указанного содержимого в файле в качестве входного параметра для интерфейса отправки конверта. Поиск осуществляется по всему документу.

Параметры запроса

Название параметра

Тип

Обязательно

Описание

fileKey

string

true

FileKey файла

keywords

array

true

Список ключевых слов, которые можно использовать для определения координат местоположения в файле

【Внимание】

  1. За один раз можно передать не более 5 ключевых слов.
  2. Ключевые слова не поддерживают специальные символы, 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": "成功"
}

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа