电子合同API开发文档 v5

合同模板上传

接口地址:https://api.1dq.com/v5/Files/template.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

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

接口描述:
上传合同模版
1、如果上传格式为docx,doc,后面在签署时可以通过接口替换相关关键词和图片,模板格式请参考 https://oss2.1dq.com/public/示范.docx
2、如果上传其他格式,不支持内容替换

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
file_content - STRING -
文件内容,需转换为base64字符串 ,取base64后面的字符串,如字符串不包含data:application/octet-stream;base64
UEsDBAxxx
file_extension - STRING -
文件后缀,如doc , docx , xls , xlsx , pdf , jpg , png , jpeg , gif , webp , ppt , pptx , csv , txt 等
docx
file_name - STRING -
文件名称
测试模板合同
easy_id 18 INT -
可选项,用户easy_id,填写后可在app或后台查看,如果您账户有多个企业,每个企业的easy_id是不一样的
175592531139104768
file_size - INT -
文件大小,单位kb
200

请求示范

 POST https://api.1dq.com/v5/Files/template.json
 {
    "easy_id": "175592531139104768",
    "file_content": "UEsDBAxxx",
    "file_extension": "docx",
    "file_name": "测试模板合同",
    "file_size": "200"
}

返回结果

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

----tpl_id

- STRING 模板id 115105290059386880

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "tpl_id": "115105290059386880"
    }
}

失败示范

{
    "code": 404,
    "msg": "tpl_name不能为空"
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码