电子合同API开发文档 v5

搜索关键词坐标

接口地址:https://api.1dq.com/v5/Tool/searchKeywordPosition.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
搜索关键字坐标

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
file_id 36 STRING -
文件id
signed-b53873dc02d34ac2bc288ea8a1d34559-99b3a5c3-0001
keyword - STRING -
关键词列表,多个以,分开,(关键词为英文或数字组成,不支持空格&、=_ 等特殊字符)
yidingqian
password 50 STRING -
文档密码

请求示范

 POST https://api.1dq.com/v5/Tool/searchKeywordPosition.json
 {
    "file_id": "signed-b53873dc02d34ac2bc288ea8a1d34559-99b3a5c3-0001",
    "keyword": "yidingqian",
    "password": ""
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

----x

- STRING x坐标

----y

- STRING y坐标

----page

- STRING 当前页数

----page_width

- STRING 页面宽度

----page_height

- STRING 页面高度

成功示范

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "x": 90,
            "y": 737.465,
            "page": 1,
            "page_width": 595.3,
            "page_height": 841.9
        },
        {
            "x": 183.6,
            "y": 586.166,
            "page": 2,
            "page_width": 595.3,
            "page_height": 841.9
        }
    ]
}

失败示范

{
    "code": 404,
    "msg": "关键词不能为空",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码