电子合同API开发文档 v5

获取模板列表

接口地址：https://api.1dq.com/v5/Templates.json

请求方式：POST

参数位置：body

权限控制：支持

接口版本： v5.0

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

接口描述：
未提供

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
easy_id 是 18 STRING -
用户的easy_id， 企业和个人分开管理，如查询无结果，请确认您上传合同模板是个人账户还是企业账户
175592531139104768

请求示范

 POST https://api.1dq.com/v5/Templates.json
 {
    "easy_id": "175592531139104768"
}

返回结果

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

----id

 否 - STRING 模板id

----name

 否 - STRING 模板名称

----status

 否 - STRING 1正常，其他为异常

----file_id

 否 - STRING 模板文件的id

----version

 否 - STRING 模板的版本号

----field

 否 - STRING 可替换的字段名称

----content

 否 - STRING v1版本为详细内容，v4为示范参数，其他版本为空

----update_time

 否 - STRING 更新时间

----create_time

 否 - STRING 创建时间

----down_link

 否 - STRING 下载链接，10分钟内有效

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "total": 1,
        "per_page": 15,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": "226203466853388288",
                "name": "我的模板",
                "status": 1,
                "file_id": "template-bcd86aa58a9a99cc3798db657de10999-3d98a592-0001",
                "version": "v3",
                "field": [],
                "content": "",
                "update_time": "2021-04-23 12:59:57",
                "create_time": "2021-04-23 12:59:57",
                "down_link": "https:\/\/safe-storage.1dq.com\/template\/bcd86aa58a9a99cc3798db657de10999\/3d98a592.docx?OSSAccessKeyId=LTAI4FngqZ56AA5Dpmxq9zSS&Expires=1619580344&Signature=B9I96ZUYrhtJXTHwwmyS9r9JxyM%3D"
            }
        ]
    }
}

失败示范

{
    "code": 404,
    "msg": "easy_id 不正确",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码