电子合同API开发文档 v5

上传需要签署的合同

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

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

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

接口描述:
1、上传文件生成合同,文件不能超过30M,支持doc , docx , xls , xlsx , pdf , jpg , png , jpeg , gif , webp , ppt , pptx , csv , txt 等格式;
2、文件需异步转换为pdf,可以使用状态查询接口查询是否转换成功(非必须);
3、上传成功后返回file_id 请记录此id 用于创建合同;
4、文件上传成功后,如未调用创建合同接口,7日后会自动删除,如该文件id创建了合同,则在用户主动删除前有效
5、同一个文件Id只能创建一份合同

请求参数

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

参数名 是否必填 长度 类型 默认值 描述 示范
file_content - STRING -
文件内容,需转换为base64字符串 ,取base64后面的字符串,如字符串不包含data:application/octet-stream;base64
UEsDBAoAAxxxx
file_extension - STRING -
文件后缀,如doc , docx , xls , xlsx , pdf , jpg , png , jpeg , gif , webp , ppt , pptx , csv , txt 等
doc
file_name - STRING -
文件名称
项目管理合同
file_size - STRING -
单位kb
500
convert - STRING 1
是否转换文档,-1不转换,1转换,默认转换
1

请求示范

 POST https://api.1dq.com/v5/Files/uploads.json
 {
    "convert": "1",
    "file_content": "UEsDBAoAAxxxx",
    "file_extension": "doc",
    "file_name": "项目管理合同",
    "file_size": "500"
}

返回结果

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

----file_id

- STRING 文件Id

----file_name

- STRING 文件名称 urlencode

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "file_id": "signed-6186f745be1744bbf4a1a79a9ebb6d3d-6141d75a-0000",
        "file_name": "%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86%E5%90%88%E5%90%8C"
    }
}

失败示范

{
    "code": 404,
    "msg": "文件大小不能为空"
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码