介质图片
用于优化上传具体的介质图片,比如商品主图、子图等;调用时指定上传场景,比如商品主图场景,即可对原图按照商品主图规范进行校验和优化。
营销图片优化上传接口。支持指定场景进行图片上传、图片校验和图片优化。若使用方选择不需要优化,则接口会根据图片的规范对上传的图片进行校验,校验失败会返回校验失败原因,校验成功则成功上传;若使用方选择需要优化,则接口会尝试对上传的原图进行优化,优化成功则返回优化后的图片,优化失败返回优化失败的原因。目前支持的图片优化能力有:图片压缩、图片裁剪、等比缩放、清晰度修复。
公共请求参数
业务请求参数
image_content|图片内容必选byte[][1,5242880]
【描述】图片的byte字节数组。图片大小限制为5m。支持格式如下:png、jpg、jpeg、bmp、webp。
【示例值】-
upload_scene|图片上传场景必选string[1,64]
【描述】图片上传场景,分为默认素材规范场景和其他具体场景。此处传具体介质图片场景即可,比如商品主图场景。
【枚举值】
商品主图场景: item_head_img
商品子图场景: item_image_list
商品sku图场景: item_sku_thumb_img
【注意事项】若选择默认素材规范场景,选择default_material_spec; 若选择其他具体场景,选择具体场景;例如 商品主图场景需要 传入 item_head_img。
【示例值】item_head_img
need_enhance|图片是否需要优化必选boolean
【描述】表示是否需要优化图片。若选择需要优化图片,系统会根据原图进行优化,再根据素材规范校验;若选择不需要优化图片,系统对原图直接校验。校验通过则上传成功,校验不通过会返回具体错误原因。
【示例值】true
image_directory_id|归属图空间目录id可选string[0,128]
【描述】归属图空间目录id。不填时,默认归属到根目录;填写时会模版保存到图片空间的目录下;当图片需要保存到根目录下时传"0"。
【示例值】2024022000903514384700020000
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.image.enhance.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'image_content=@/home/admin/test.jpg' \
-f 'upload_scene=item_head_img' \
-f 'need_enhance=true' \
-f 'image_directory_id=2024022000903514384700020000'
说明:本示例仅供参考。
公共响应参数
业务响应参数
image_id|图片id必选string(64)
【描述】图片唯一资源id
【示例值】a*fxurrkq_tjmaaaaaaaaaaaaadjf2aq
image_url|图片链接必选string(128)
【描述】图片上传后返回的链接
【示例值】https://mdn.alipayobjects.com/mrch_material/afts/img/a*fxurrkq_tjmaaaaaaaaaaaaadjf2aq/original
image_enhanced|图片是否优化过必选boolean(16)
【描述】图片是否优化过。系统会根据要求,若上传的图片不符合规范,会对图片进行优化。
【示例值】true
image_index_id|图索引id必选string(128)
【描述】图索引id。图在相册中的索引id。
【示例值】2024022000903514384700000000
响应示例
正常示例
异常示例
{
"alipay_marketing_image_enhance_upload_response": {
"code": "10000",
"msg": "success",
"image_id": "a*fxurrkq_tjmaaaaaaaaaaaaadjf2aq",
"image_url": "https://mdn.alipayobjects.com/mrch_material/afts/img/a*fxurrkq_tjmaaaaaaaaaaaaadjf2aq/original",
"image_enhanced": true,
"image_index_id": "2024022000903514384700000000"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 请重新发起请求 |
invalid_parameter | 参数有误 | 请根据接口返回的错误信息,检查请求参数,修改后重新发起 |
data_not_exist_error | 素材规范id不存在 | 请从素材规范id的来源处确认素材规范id的正确性 |
image_enhance_failed | 图片优化失败 | 图片优化失败,请替换图片重新上传优化 |
vfs_image_num_limit_error | 图数量限制错误 | 删除相册中不使用的图后,再尝试录入新的图片 |