上传印章图片概述
上传本地印章图片文件到e签宝服务端请按以下步骤顺序操作:
步骤一:获取印章图片上传地址fileUploadUrl
(点击直接跳转下方 步骤一)
步骤二:将印章图片文件流上传到fileUploadUrl
(点击直接跳转下方 步骤二)
- 以上二个步操作缺一不可,上传印章图片时请按序调用。
- 请上传真实有效的印章图片,支持 jpg、jpeg、png、bmp格式图片,印章图片大小需控制在2M以内。
步骤一:获取印章图片上传地址fileUploadUrl
接口描述
用于获取上传印章图片文件的服务端地址fileUploadUrl
和印章图片fileKey
。
接口地址&请求方法
接口地址:https://{host}/v3/files/file-key
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
contentMd5 | string | 是 | body | 文件的Content-MD5值。 先获取文件MD5的128位二进制数组,再对此二进制进行Base64编码。 (1)可参考Content-MD5计算说明及代码示例计算。 (2)开发调试时可通过【获取文件哈希值小工具】计算。 |
contentType | string | 是 | body | 目标文件的MIME类型,固定值:application/octet-stream |
fileName | string | 是 | body | 本地印章图片文件名称(含扩展名,示例:赵某某.png)
|
fileSize | int64 | 是 | body | 印章图片大小,单位byte |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | |
data(点击“+”展开详情) | object | 否 | 业务数据 | |
fileKey | string | 否 | 印章图片的fileKey(开发者需妥善保存fileKey,可用于创建图片印章) | |
fileUploadUrl | string | 否 | 印章图片服务端上传地址,链接有效期60分钟。(请继续按下方步骤二将文件流上传到该地址中) |
请求示例
{
"contentMd5":"eGMHwA4TW***KMxreUQ==",
"contentType":"application/octet-stream",
"fileName":"这是个自定义图片印章.png",
"fileSize":1525
}
响应示例
{
"message": "成功",
"code": 0,
"data": {
"fileKey": "$c3c7170e-xx-xx-xx-xx",
"fileUploadUrl": "https://esignoss.esign.cn/7438861007/xx-xx-xx-xx-xx/%E5%8C%BA%E5%9D%97%E9%93%BE%E7%AD%BE%E7%BD%B2%E6%B5%81%E7%A8%8B%E5%9B%BE.pdf?Expires=1651892150&OSSAccessKeyId=STS.NTvgoN7TLTsKEfgA2QQa5zRP8&Signature=gHbOQTnhHfUka%2FqTuO2yTNH7MPo%3D&callback-var=eyJ4OmZpbGVfa2V5IjoiJGMzYzcxNzBlLTA5MWUtNGRmYi05Y2M0LWNjYjA0NjM4ZjJmYyQyMjIyODMxOTg0In0%3D%0A&callback=eyJjYWxsYmFja1VybCI6Imh0dHA6Ly9zbWx0YXBpLnRzaWduLmNuL2FueWRvb3IvZmlsZS1zeXN0ZW0vY2FsbGJhY2svYWxpb3NzIiwiY2FsbGJhY2tCb2R5IjogIntcIm1pbWVUeXBlXCI6JHttaW1lVHlwZX0sXCJzaXplXCI6ICR7c2l6ZX0sXCJidWNrZXRcIjogJHtidWNrZXR9LFwib2JqZWN0XCI6ICR7b2JqZWN0fSxcImV0YWdcIjogJHtldGFnfSxcImZpbGVfa2V5XCI6JHt4OmZpbGVfa2V5fX0iLCJjYWxsYmFja0JvZHlUeXBlIjogImFwcGxpY2F0aW9uL2pzb24ifQ%3D%3D%0A&security-token=CAIS%2BAF1q6Ft5B2yfSjIr5fDLNX62ott47GgR0DWpTIEXe4ZlZf72jz2IHtKdXRvBu8Xs%2F4wnmxX7f4YlqB6T55OSAmcNZEoBGKafeL5MeT7oMWQweEurv%2FMQBqyaXPS2MvVfJ%2BOLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fm6%2FNgdc9FHHPPD1x8CcxROxFppeIDKHLVLozNCBPxhXfKB0ca0WgVy0EHsPnvm5DNs0uH1AKjkbRM9r6ceMb0M5NeW75kSMqw0eBMca7M7TVd8RAi9t0t1%2FIVpGiY4YDAWQYLv0rda7DOltFiMkpla7MmXqlft%2BhzcgeQY0pc%2FRqAAWB1nmVO9V5bLEJ%2Bmfc0aYUty97F5iHIbjugzY2bdYrKy39zXIZFLk0wIUBYPDH43gn4AzdLFsS%2Fw5ZZtkNiN5d9PXKvaheqCVtogy%2F2i7Se6L%2FOJNfbF%2FNVrXFNlgi8UKCKgWSOtAvYLT5rSfq0%2FSfpaqd%2Boi8iZW%2F6q1F%2BCy%2Fi"
}
}
错误码
步骤二:将印章图片文件流上传到fileUploadUrl
上传地址&请求方法
接口地址:【步骤一:获取印章图片上传地址】的响应参数fileUploadUrl
请求方法:PUT
请求头格式
参数名称 | 参数类型 | 必选 | 参数说明 |
Content-MD5 | string | 是 | 与【步骤一:获取印章图片上传地址】Body体中contentMd5值一致 必须跟上述说明接口的contentMd5参数一致,否则会报403错误 |
Content-Type | string | 是 | 固定值:application/octet-stream |
提示:如果文件流上传时出现报错,请参考文件上传常见报错及解决方法尝试解决。
请求参数
HTTP BODY:待上传文件的二进制字节流。
注意:此文件必须与contentMd5值对应的文件一致
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
errCode | int32 | 是 | 业务码,0表示成功,非0表示异常。 |
msg | string | 否 | 业务信息 |