商家券
营销通用上传图片接口
公共请求参数
业务请求参数
file_content|图片内容必选byte[](2097152)
【描述】图片的byte字节数组。图片大小限制为2m
【示例值】-
merchant_access_mode|商户接入模式必选string(32)
【描述】商户接入模式
枚举值
self_mode 商户自接入模式
agency_mode 服务商代接入模式
枚举值
self_mode 商户自接入模式
agency_mode 服务商代接入模式
【枚举值】
商户自接入模式: self_mode
服务商代接入模式: agency_mode
【注意事项】选择服务商代接入模式需配合 app_auth_token 代调用使用
【示例值】self_mode
file_key|文件业务标识特殊可选string(32)
【描述】文件业务标识。
alipay.marketing.activity.delivery.create接口中 delivery_base_info.delivery_material.delivery_single_material.delivery_image 当delivery_booth_code=public_union,上传图片接口需指定file_key=public_union_channel_pic;
当delivery_booth_code=payment_result,上传图片接口需指定file_key=delivery_channel_pic。上传图片更多要求参考文档: https://render.alipay.com/p/c/18tpirlg12e8?operatefrom=balipay
alipay.marketing.activity.ordervoucher.create接口中 voucher_display_pattern_info.brand_logo字段,file_key=promo_brand_logo,voucher_display_pattern_info.voucher_image 字段,file_key=promo_voucher_image
alipay.marketing.activity.delivery.create接口中 delivery_base_info.delivery_material.delivery_single_material.delivery_image 当delivery_booth_code=public_union,上传图片接口需指定file_key=public_union_channel_pic;
当delivery_booth_code=payment_result,上传图片接口需指定file_key=delivery_channel_pic。上传图片更多要求参考文档: https://render.alipay.com/p/c/18tpirlg12e8?operatefrom=balipay
alipay.marketing.activity.ordervoucher.create接口中 voucher_display_pattern_info.brand_logo字段,file_key=promo_brand_logo,voucher_display_pattern_info.voucher_image 字段,file_key=promo_voucher_image
【示例值】promo_voucher_image
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.material.image.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'file_content=@/home/admin/test.jpg' \
-f 'file_key=promo_voucher_image' \
-f 'belong_merchant_info={
"merchant_id_type":"smid",
"business_type":"isv_for_merchant",
"merchant_id":"2088202967380463"
}' \
-f 'merchant_access_mode=self_mode'
说明:本示例仅供参考。
公共响应参数
业务响应参数
resource_id|图片唯一资源id必选string(64)
【描述】图片唯一资源id
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
resource_enhance|是否优化过特殊可选boolean(16)
【描述】图片是否优化过。系统会根据要求,对上传的图片做尺寸的优化。
【示例值】false
resource_url|图片的url地址特殊可选string(128)
【描述】上传后图片的url地址
【示例值】https://mdn.alipayobjects.com/afts/img/a*o-bsqa2pnq4mifdcjunmqaaaarwnaq/original?bz=promo_merchant
响应示例
正常示例
异常示例
{
"alipay_marketing_material_image_upload_response": {
"code": "10000",
"msg": "success",
"resource_id": "adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"resource_enhance": false,
"resource_url": "https://mdn.alipayobjects.com/afts/img/a*o-bsqa2pnq4mifdcjunmqaaaarwnaq/original?bz=promo_merchant"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙,文件上传失败 | 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误请求参数异常 | 请求参数异常,请根据具体返回的错误信息排查后,重新设置入参 |
file_size_out_of_range | 文件大小超过限制 | 请使用图片文件上传接口重新上传图片,大小不能超过2m |
file_type_error | 文件格式不正确,不是图片文件格式 | 请使用图片上传接口上传图片类型的文件,不支持其他文件类型 |
material_error | 文件格式不正确 | 请详细阅读相关接口字段描述,上传正确的文件。
请检查文件大小是否满足需求,图片宽度和高度是否满足需求,图片是否清晰,图片是否存在违规内容。 |
pic_suffix_illegal | 文件后缀名称不合法 | 仅支持文件后缀名称为bmp, png, jpg, jpeg, gif的图片文件,请重新上传 |