通用场景
小程序基于模板上传版本
公共请求参数
业务请求参数
template_id|小程序模板 appid必选string[0,32]
【描述】小程序模板 appid。
【注意事项】template_id是小程序模板appid,不是三方应用appid。小程序模板请在开发者中心控制台-三方应用-应用详情-小程序模板-小程序模板管理 中获取。
【示例值】1
app_version|商家小程序版本号必选string[0,64]
【描述】商家小程序版本号。版本号必须满足 x.y.z, 且均为数字。要求版本号比商户之前最新的版本号高。
【示例值】0.0.1
template_version|小程序模板版本号可选string[1,64]
【描述】小程序模板版本号。版本号必须满足 x.y.z, 且均为数字。不传默认使用最新在架(已上架)模板版本。
【示例值】0.0.1
ext|自定义参数可选string[1,4096]
【描述】自定义参数,用于配置商家小程序的个性化内容,具体使用方法参见示例代码。
在小程序中可以通过 my.getextconfig() 或 my.getextconfigsync() 获取 ext 参数内容(建议支付宝版本 > 10.1.38,并使用 my.caniuse 做兼容处理)。
【示例值】{"extenable": true, "extpages": {"pages/face/index": {"defaulttitle": "哈哈哈哈"}},"window": {"defaulttitle": "ai2"}}
bundle_id|小程序投放的端参数可选string[1,64]
【描述】小程序客户端类型,默认为支付宝端。常见支持如下客户端:
com.alipay.alipaywallet:支付宝端;
com.alibaba.android.rimet:dingding端;
com.amap.app:高德端;
com.alibaba.ailabs.genie.webapps:天猫精灵端;
com.alipay.iot.xpaas:支付宝iot端。
如需更多端投放,请联系业务bd。
【示例值】com.alipay.alipaywallet
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.mini.version.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"template_version":"0.0.1",
"ext":"{\"extenable\": true, \"extpages\": {\"pages/face/index\": {\"defaulttitle\": \"哈哈哈哈\"}},\"window\": {\"defaulttitle\": \"ai2\"}}",
"template_id":"1",
"app_version":"0.0.1",
"bundle_id":"com.alipay.alipaywallet"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
build_status|构建状态可选string(8)
【描述】构建的状态,0-构建排队中;1-正在构建;2-构建成功;3-构建失败;5-构建超时
【示例值】0
need_rotation|是否需要轮询可选string(8)
【描述】是否需要轮询
【示例值】"true"
create_status|创建版本的状态可选string(8)
【描述】创建版本的状态,0-构建排队中;1-正在构建;2-构建成功;3-构建失败;5-构建超时;6-版本创建成功
【示例值】6
version_created|是否创建了版本可选string(16)
【描述】是否创建了版本
【示例值】true
响应示例
正常示例
异常示例
{
"alipay_open_mini_version_upload_response": {
"code": "10000",
"msg": "success",
"build_status": "0",
"need_rotation": "\"true\"",
"create_status": "6",
"version_created": "true"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
application_type_not_miniapp | 该应用不是小程序类型 | 请使用小程序类型的应用 |
app_info_not_exist | 应用信息不存在 | 应用信息不存在,请检查商家小程序是否存在 |
app_to_app_auth_fail | 应用授权失败 | 应用授权失败,请稍后重试 |
app_type_error | 只允许普通、门店小程序才允许使用通过模版的构建方式 | 只允许普通、门店小程序才允许使用通过模版的构建方式,不允许模板构建模板。 |
app_version_is_blank | 版本号为空 | 请输入小程序的版本号 |
build_version_compare_error | 目标端存在更高的版本 | 目标端存在更高的版本 |
bundle_id_not_exist | 端参数不存在 | 请根据示例值输入正确的端参数 |
code_template_deleted | 指定的代码模板已经删除 | 请使用没有删除的代码模板 |
code_template_not_exist | 指定的代码模板不存在 | 请输入合法的小程序代码模板id |
code_template_not_exist | 指定的代码模板未构建成功 | 请输入合法的小程序代码模板id |
code_template_not_safe | 指定的代码模板未进行安全扫描 | 请等待安全扫描之后再使用该模板 |
dev_version_exceed_max_count | 小程序开发版本个数超过最大数量 | 小程序开发版本个数最多20个 |
invalid_ext_json | 扩展信息格式解析错误 | 请输入正确的json |
invalid_params | 参数非法 | 请检查参数后,重试 |
invalid_version | 非法的小程序版本号 | 小程序版本号,版本号必须满足 x.y.z, 且均为数字 |
isv_app_id_is_blank | 三方应用id不存在 | 该接口需要带应用授权token来调用 |
larger_version_has_existed | 存在更大的商家小程序版本号 | 请重新输入商家小程序版本号app_version参数 |
mini_app_package_info_not_exist | 模板版本信息不存在 | 请确保该模板存在上架或下架版本,或者对应的版本号的版本存在 |
no_auth_relation | 托管小程序和三方应用之间不存在授权关系 | 请先将托管小程序授权给三方应用 |
template_extra_info_invalid | 模板拓展信息格式错误 | 请检查参数后,重试 |
template_id_isvappid_not_match | 模板id和isvappid不匹配 | 检查templateid是否属于发起调用的三方应用 |
template_id_is_blank | 模板id为空 | 请输入模板id |
template_miniapp_not_allowed | 模板小程序不允许通过该接口构建 | 请用ide来上传模板小程序的版本 |
template_not_online_or_offline | 模板版本非上架或下架状态 | 请使用上架或下降状态的模板版本 |
template_status_can_not_build | 版本非上架/下架/开发中/审核驳回状态 | 使用非上架/下架/开发中/审核驳回状态的模版版本构建 |
template_status_punished | 版本被处罚,无法构建 | 使用不被处罚的模版版本构建 |
update_plugin_service_fail | 更新插件关联关系失败 | 更新插件关联关系失败,请稍后重试 |
version_exceeded_length | 版本号单个数字最大为2147483647 | 修改版本号重新上传,数字最大可为2147483647 |
version_has_existed | 请重新输入新的版本号 | 请重新输入小程序版本号 |
version_has_existed | 上过架的版本已经存在 | 请重新输入小程序版本号 |
version_has_existed | 开发中的版本已经存在 | 请重新输入小程序版本号 |
version_has_existed | 审核中的版本已经存在 | 请重新输入小程序版本号 |
version_has_existed | 审核驳回的版本已经存在 | 请重新输入小程序版本号 |
version_has_existed | 审核通过的版本已经存在 | 请重新输入小程序版本号 |
version_has_existed | 灰度中的版本已经存在 | 请重新输入小程序版本号 |