获取文件关键字坐标

上传合同文件后，可使用该接口获取合同文件中关键字的所在pdf的页数及坐标。

提示

用于合同内容经常变动时，需要在指定位置（关键字）盖章情况

例如：

甲方位置盖章只需传入参数：“甲方（签名/盖章）”
已方位置盖章只需传入参数：“乙方（签名/盖章）”

调用顺序如下：

1.调用上传合同文件或基于模板创建合同文件接口获得合同文件fileCode。
2.此接口获取关键字所在位置
3.在发起合同接口中【signers-signFields-signFieldPosition】(签章区域配置)填写印章的坐标信息

请求头格式

具体请求头参数，请查看公共请求格式

请求参数

Body 参数application/json

fileCode

string

文件编码

必需

文件唯一编码，“上传合同文件”或“基于模板创建合同文件”时返回的fileCode

keywords

array[string]

关键字数组

必需

需要查找的关键字

示例

{
  "fileCode": "FC_20240701135838NuFSJvOgmgewLRq",
  "keywords": [
    "甲方",
    "乙方"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

object

必需

keywordInfos

array [object {2}]

必需

code

string

请求结果编码

必需

msg

string

请求结果

必需

logKey

string

日志key

必需

string

时间戳

必需

success

boolean

是否成功

必需

示例

{
  "result": {
    "keywordInfos": [
      {
        "keyword": "乙方",
        "positions": [
          {
            "positionPage": 6,
            "positionX": 180,
            "positionY": 87
          }
        ]
      },
      {
        "keyword": "甲方",
        "positions": [
          {
            "positionPage": 6,
            "positionX": 492,
            "positionY": 87
          },
          {
            "positionPage": 6,
            "positionX": 390,
            "positionY": 110
          }
        ]
      }
    ]
  },
  "code": "200",
  "msg": "成功",
  "logKey": "a57d1a93",
  "ts": "1719918221417",
  "success": true
}

例如：#

调用顺序如下：#

请求头格式#

请求参数

示例代码

返回响应

例如：

调用顺序如下：

请求头格式