通过上传方式创建文件
接口地址 /v1/files/getUploadUrl
请求方式 POST
接口描述
- 采用上传方式创建文件。对接方通过该接口获取文件上传的授权地址,上传方法请参考:文件流上传方法
- 签署流程中的待签文件和附件都可使用本接口进行上传。但签署文档仅支持pdf,其他文档需转换成pdf再签署,附件文件的格式不限。目前文档转换支持以下格式:DOC, DOCX, WPS, RTF, XLS, ET, XLSX, JPG, GIF, JPEG, BMP, PNG, TIF, TIFF, PPT, DPS, PPTX, HTM, HTML,其他格式会转换失败。为避免文档转换异常导致服务中断,强烈建议开发者自行将其他格式文档转换成PDF后再上传。
- 上传文件大小限制在50M以内。
请求参数
参数名称 | 说明 | 参数类型 | 必填 | 类型 |
---|---|---|---|---|
contentMd5 | 先计算文件md5值,在对该md5值进行base64编码 | body | true | string |
contentType | 目标文件的MIME类型 | body | true | string |
convert2Pdf | 是否转换成pdf文档,默认false,代表不做转换。转换是异步行为,如果指定要转换,需要调用查询文件信息接口查询状态,转换完成后才可使用。若使用文件转换,大小需限制在30M以内,大于30M的文件请先自行转成pdf后再上传。 | body | true | string |
fileName | 文件名称(必须带上文件扩展名,不然会导致后续发起流程校验过不去 示例:合同.pdf ) | body | true | string |
fileSize | 文件大小,单位byte | body | true | int64 |
请求示例
POST https://openapi.esign.cn/v1/files/getUploadUrl
{
"contentMd5":"eGMHwA4TWnbg6PYKMxreUQ==",
"contentType":"application/octet-stream",
"convert2Pdf":false,
"fileName":"附件.zip",
"fileSize":2542635
}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
fileId | 文件Id | string |
uploadUrl | 文件直传地址, 可以重复使用,但是只能传一样的文件,有效期一小时 | string |
响应示例
{
"code":0,
"data":{
"fileId":"049d33945cde46b7953bf377fe2a7608",
"uploadUrl":"https://esignoss.oss-cn-hangzhou.aliyuncs.com/1111563786/d8d35867-744b-47f3-890f-e3650efd99e1/%E9%99%84%E4%BB%B6.zip?Expires=1561472338&OSSAccessKeyId=STS.NHmxRMcKLPqz9km2veAujyrCB&Signature=aM8p6T/Sby30bBUVt%2BfOcYR36t0%3D&callback-var=eyJ4OmZpbGVfa2V5IjoiJGFkNTlkZjExLThmNzMtNDdkZC05MTIwLTk1MDNlOTk4NDNkYSQzMTc3NzA4NTIifQ%3D%3D%0A&callback=eyJjYWxsYmFja1VybCI6Imh0dHA6Ly90ZmlsZS50c2lnbi5jbi9maWxlLXN5c3RlbS9jYWxsYmFjay9hbGlvc3MiLCJjYWxsYmFja0JvZHkiOiAie1wibWltZVR5cGVcIjoke21pbWVUeXBlfSxcInNpemVcIjogJHtzaXplfSxcImJ1Y2tldFwiOiAke2J1Y2tldH0sXCJvYmplY3RcIjogJHtvYmplY3R9LFwiZXRhZ1wiOiAke2V0YWd9LFwiZmlsZV9rZXlcIjoke3g6ZmlsZV9rZXl9fSIsImNhbGxiYWNrQm9keVR5cGUiOiAiYXBwbGljYXRpb24vanNvbiJ9%0A&security-token=CAIS%2BAF1q6Ft5B2yfSjIr4vYM%2Bj5jpRt57ORO03c1nYwTfpGlrfooDz2IHtKdXRvBu8Xs/4wnmxX7f4YlqB6T55OSAmcNZEoDH68YdPkMeT7oMWQweEurv/MQBqyaXPS2MvVfJ%2BOLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B/m6/Ngdc9FHHPPD1x8CcxROxFppeIDKHLVLozNCBPxhXfKB0ca0WgVy0EHsPnvm5DNs0uH1AKjkbRM9r6ceMb0M5NeW75kSMqw0eBMca7M7TVd8RAi9t0t1/IVpGiY4YDAWQYLv0rda7DOltFiMkpla7MmXqlft%2BhzcgeQY0pc/RqAAWbkTMmUIhYPd/RICa6Mo/WvK%2BqWh2U1FUDTcoyOUFICU9W6AT9DIA5nqxIlfGpOrIsQtCXK5Nl5lqX3aRev2zbr9ZhFcHWRPZ2GZKr92ppjxCThZ756EG49vggXLFd3VHRQT3ABI90LcXPxkmVrEW5nji4wJKX3k1AO0G6Whpjn"
},
"message":"成功"
}
错误码
错误码 | 错误信息 | 错误原因 |
---|---|---|