电子合同API开发文档 v5

签署合同-根据关键词签署

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

请求方式:POST

参数位置:body

权限控制:不支持

接口版本: 5.0.2 5.1.6 5.2.3

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

接口描述:
查找事先自定义的关键字,实现快速签署

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 18 STRING -
签署用户的easy_id,如果有多个用户需要签署,请循环调用本接口
175592531139104768
open_id - STRING -
用户id
2c6084c0-ad71-11ea-9664-0242ac320a0c
signed_data - JSON -
签署信息(关键词为英文或数字组成,不支持空格&、=_等特殊字符),使用json格式,格式示范[ { "seal_id":"印章id", "keyword":"关键词" }, { "seal_id":"印章id2", "keyword":"关键词2" } ]
查看示范
[ { "seal_id": "deb4cf5e-ed14-11ea-aa79-0242ac110007", "keyword": "my-keyword-01" }, { "seal_id": "4cde8b9e-ebfa-11ea-b678-0242ac110011", "keyword": "my-keyword-02" } ]
words_id - STRING -
文档id
certification_code - STRING -
选填项,意愿认证code, 通过意愿认证接口获得
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
certification_type - STRING -
选填项,意愿认证类型
mobile
org_id - STRING -
企业id,如果需要使用企业印章必须传递
abf447a8-ad71-11ea-b95e-0242ac320a0c

请求示范

 POST https://api.1dq.com/v5/Contracts/signedByKeyword.json
 {
    "certification_code": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    "certification_type": "mobile",
    "easy_id": "175592531139104768",
    "signed_data": "[ { \"seal_id\":\"deb4cf5e-ed14-11ea-aa79-0242ac110007\", \"keyword\":\"my-keyword-01\" }, { \"seal_id\":\"4cde8b9e-ebfa-11ea-b678-0242ac110011\", \"keyword\":\"my-keyword-02\" } ]",
    "words_id": ""
}

返回结果

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

成功示范

{
    "code": 200,
    "msg": "签署成功",
    "data": []
}

失败示范

{
    "code": 404,
    "msg": "页面信息不正确",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码