キーワードから座標を取得

POST /esignglobal/v1/files/keywordPositions

インターフェースの説明

APIを使用してエンベロープを開始する前に、このインターフェースを使用して、指定されたコンテンツのファイル上の座標を取得し、エンベロープ開始インターフェースの入力パラメーターとして使用できます。検索範囲はドキュメント全体です。

リクエストパラメータ

パラメータ名

タイプ

必須

説明

fileKey

string

true

ファイルfileKey

keywords

array

true

キーワードリスト。この値を使用して、ファイル内の位置座標を特定できます。

【注意】

一度に最大5つのキーワードを渡すことができます。
キーワードは、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": "成功"
}