电子合同API开发文档 v5

设置签署位置

接口地址:https://api.1dq.com/v5/Contracts/positionSign.json

请求方式:POST

参数位置:body

权限控制:不支持

接口版本: 5.0.2 5.1.6 5.2.3

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

接口描述:
可选项,提前设置位置,用户只能在该区域盖章或签字

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 18 STRING -
用户的easy_id
175592531139104768
position - JSON -
位置信息
查看示范
[ { "x": "200", "y": "200", "page": "第几页", "seal_type": "1、普通印章,2、骑缝章", "user_type": "类型,1为个人,2为企业", "seal_width": "无特殊要求,不用传递,为空默认即可。签署区域宽度", "seal_height": "无特殊要求,不用传递,为空默认即可。签署区域高度", "area_title": "无特殊要求,不用传递,为空默认即可。签署提示", "page_width": "无特殊要求,不用传递,为空默认即可。指定页面宽度", "sign_id": "无特殊要求,不用传递,为空默认即可。签署人或填写人id" } ]
words_id 36 STRING -
合同id
number - STRING -
通过手机号/邮箱进行设置
test@1dq.com

请求示范

 POST https://api.1dq.com/v5/Contracts/positionSign.json
 {
    "easy_id": "175592531139104768",
    "number": "test@1dq.com",
    "position": "[\r\n    {\r\n        \"x\": \"200\",\r\n        \"y\": \"200\",\r\n        \"page\": \"第几页\",\r\n        \"seal_type\": \"1、普通印章,2、骑缝章\",\r\n        \"user_type\": \"类型,1为个人,2为企业\",\r\n\r\n        \"seal_width\": \"无特殊要求,不用传递,为空默认即可。签署区域宽度\",\r\n        \"seal_height\": \"无特殊要求,不用传递,为空默认即可。签署区域高度\",\r\n        \"area_title\": \"无特殊要求,不用传递,为空默认即可。签署提示\",\r\n        \"page_width\": \"无特殊要求,不用传递,为空默认即可。指定页面宽度\",\r\n        \"sign_id\": \"无特殊要求,不用传递,为空默认即可。签署人或填写人id\"\r\n    }\r\n]",
    "words_id": ""
}

返回结果

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

成功示范

{
    "code": 200,
    "msg": "success",
    "data": []
}

失败示范

{
    "code": 404,
    "msg": "位置信息不能为空",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码