Central do desenvolvedor

Obter coordenadas com base em palavras-chave

POST /esignglobal/v1/files/keywordPositions

Descrição da Interface

Antes de iniciar um envelope usando a API, pode usar esta interface para obter as coordenadas do conteúdo especificado no ficheiro, como um parâmetro de entrada para a interface de início do envelope. O âmbito da pesquisa é todo o documento.

Parâmetros de Pedido

Nome do Parâmetro

Tipo

Obrigatório

Descrição

fileKey

string

true

fileKey do ficheiro

keywords

array

true

Lista de palavras-chave, que podem ser usadas para localizar as coordenadas da posição no ficheiro

【Atenção】

  1. Pode transmitir no máximo 5 palavras-chave de cada vez.
  2. As palavras-chave não suportam caracteres especiais, emojis e outros caracteres que o Adobe não consegue analisar.

Exemplo de Pedido

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

Parâmetros de Resposta

Nome do Parâmetro

Tipo

Descrição

keywordPositions

array

Informação da palavra-chave

 

keyword

array

Palavra-chave

 

searchResult

boolean

A palavra-chave recuperou valores de coordenadas?

 

 

positions

array

Informação de localização da palavra-chave

 

 

pageNum

int

Número da página onde a palavra-chave se encontra

 

 

coordinates

array

Valores das coordenadas XY da palavra-chave

【Atenção】A localização das coordenadas é feita de acordo com o primeiro caractere da palavra-chave, e a matriz de coordenadas é ordenada por ordem decrescente da coordenada Y e, em seguida, por ordem crescente da coordenada X

 

 

 

positionX

float

Coordenada X

 

 

 

positionY

float

Coordenada Y

Exemplo de resposta

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

 

Descrição da Interface
Parâmetros de Pedido
Exemplo de Pedido
Parâmetros de Resposta
Exemplo de resposta