通用场景
系统商需要先将商户需要使用的图片和视频,上传支付宝服务器,生成对应的图片id后才能够在口碑平台上配置相应图片
本接口为文件上传类接口,与普通openapi接口的入参构造格式不同,如果您没有使用官方sdk发起openapi调用,自行构造http请求时,需要使用multipart/form-data格式发起请求,注意以下事项:
1. 文件参数单独作为一个part,key为参数名,内容为文件,需要携带完整文件名(例如:content-disposition: form-data; name="file_content"; filename="example.png"),缺少文件名或后缀,会提示为类型错误。
2. 其余参数,对于v2版本的协议,公共参数需要使用query传入,业务参数使用query或body传入,使用body时每个字段作为一个单独part;v3协议需要按接口约定位置传入
1. 文件参数单独作为一个part,key为参数名,内容为文件,需要携带完整文件名(例如:content-disposition: form-data; name="file_content"; filename="example.png"),缺少文件名或后缀,会提示为类型错误。
2. 其余参数,对于v2版本的协议,公共参数需要使用query传入,业务参数使用query或body传入,使用body时每个字段作为一个单独part;v3协议需要按接口约定位置传入
公共请求参数
业务请求参数
image_type|图片/视频格式必选string[1,8]
【描述】图片/视频格式
【示例值】jpg或mp4
image_name|图片/视频名称必选string[1,128]
【描述】图片/视频名称
【示例值】海底捞
image_content|图片内容必选byte[][0,5242880]
【描述】图片/视频二进制内容,图片/视频大小不能超过5m
【示例值】-
image_pid|所属pid可选string[1,16]
【描述】用于显示指定图片/视频所属的partnerid(支付宝内部使用,外部商户无需填写此字段)
【示例值】2088021822217233
常见请求示例
推荐示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.offline.material.image.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'image_name=海底捞' \
-f 'image_type=jpg' \
-f 'image_content=@/home/admin/test.jpg'
说明:本示例仅供参考。
公共响应参数
业务响应参数
image_id|图片id必选string(32)
【描述】图片/视频在商家中心的唯一标识
【示例值】hotq1lt1ttojcxgflvnuxgaaacmaaqed
image_url|图片/视频的访问地址必选string(512)
【描述】图片/视频的访问地址(为了防止盗链,该地址不允许嵌在其他页面展示,只能在新页面展示)
【示例值】http://dl.django.t.taobao.com/rest/1.0/image?fileids=v9rfg69ssimlzg5wda3yegaaacma...
响应示例
正常示例
异常示例
{
"alipay_offline_material_image_upload_response": {
"code": "10000",
"msg": "success",
"image_id": "hotq1lt1ttojcxgflvnuxgaaacmaaqed",
"image_url": "http://dl.django.t.taobao.com/rest/1.0/image?fileids=v9rfg69ssimlzg5wda3yegaaacma..."
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
capacity_exceeded | 上传失败,单个商户最多添加5000张图片/视频 | 请删除该商户不再需要的图片/视频后再上传 |
exceed_max_size | 图片/视频大小不得超过5m/50m,请压缩后上传 | 请适当压缩图片/视频大小以免超过上传限制 |
invalid_file_bytes | 上传失败,上传文件非图片/视频类型 | 请确保文件字节流为图片/视频文件(不包括cmyk格式的图片) |
invalid_param | 接口输入参数不合法 | 检查并更改输入参数 |
unknown_format | 上传失败,只支持bmp,png,jpeg,jpg,gif格式的图片和mp4格式的视频 | 请不要使用非常用的图片/视频格式,如cmyk |
isv.exceed-max-size | 超过单个图片允许的最大值 (5m) | 请适当压缩图片大小以免超过上传限
制 |
isv.image-unsafe | 文件未通过安全校验 | 图片中可能注入了恶意代码,请重新制作图片 |
isv.invalid-arguments | 接口输入参数不合法 | 检查并更改输入参数 |
isv.unknown-error | 未知异常 | 请重试 |
isv.unknown-fomat | 文件格式不支持 | 请不要使用非常用的图片格式,如cmyk |