接口说明
接口英文名称：alipay.open.mini.qrcode.bind
请求url：https://openapi.alipay.com/v3/alipay/open/mini/qrcode/bind
请求方式：post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
商户可不需更换线下二维码，通过该接口完成配置后，用户用支付宝扫描普通二维码时打开小程序并跳转到指定页面，普通二维码关联小程序最多可设置100条规则。
请求参数
公共请求参数
展开业务请求参数
| 参数中文名 | 参数英文名 | 类型 | 是否必选 | 长度/取值 | 描述 | 示例值 |
|---|---|---|---|---|---|---|
| 路由规则url | route_urlbody | string | 必选 | 长度范围：[1,128] | 二维码域名，须通过icp备案验证，支持http、https、ftp开头的链接 | https://www.yoursite.com/ |
| 匹配规则 | modebody | string | 必选 | 长度范围：[1,16] | 匹配规则，仅支持exact（精确匹配）、fuzzy（模糊匹配）两个值。
精确匹配：根据填写的二维码地址精确匹配，地址完全一致时才能唤起小程序（如：配置二维码地址为，当用户扫这个地址的二维码可唤起小程序）。
模糊匹配：根据填写的二维码地址模糊匹配，只要地址前缀匹配即可唤起小程序（如：配置二维码地址为，当用户扫的二维码地址为,可唤起小程序）。 枚举值 根据填写的二维码地址精确匹配，地址完全一致时才能唤起小程序（如：配置二维码地址为https://www.alipay.com/my?id=123，当用户扫这个地址的二维码可唤起小程序）: exact 根据填写的二维码地址模糊匹配，只要地址前缀匹配即可唤起小程序（如：配置二维码地址为https://www.alipay.com/my/，当用户扫的二维码地址为https://www.alipay.com/my/id=123,可唤起小程序）: fuzzy | fuzzy |
| 小程序功能页地址 | page_redirectionbody | string | 必选 | 长度范围：[1,128] | 小程序功能页，配置扫描二维码后打开的小程序功能页面路径 | pages/index/index |
| 模式 | route_patternbody | string | 可选 | 长度范围：[1,256] | 模式，用于描述通用的路由url格式，适用于同一个host下面存在大量路由的场景，主要用于提升路由性能，其中{0}、{1} 代表路径中的变量 | http://yoursite.com/merchant/{0}/shop/{1} |
请求示例
curl
java
c#
php
curl -x post \
"https://openapi.alipay.com/v3/alipay/open/mini/qrcode/bind" \
-h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
-h "alipay-request-id: ${requestid}" \
-h "alipay-app-auth-token: ${app_auth_token}" \
-h "content-type: application/json" \
-d '{
"route_url":"https://www.yoursite.com/",
"mode":"fuzzy",
"page_redirection":"pages/index/index",
"route_pattern":"http://yoursite.com/merchant/{0}/shop/{1}"
}'
响应参数
公共响应参数
展开业务响应参数
| 参数中文名 | 参数英文名 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|---|
| 路由规则组 | route_group | string | 必选 | 128 | 路由规则组，用于唯一标记一条路由规则 | 78b59c5b6b2946448bc77e17e544b813 |
响应示例
正常示例
异常示例
{
"route_group":"78b59c5b6b2946448bc77e17e544b813"
}错误码
公共错误码
前往查看业务错误码
| 状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|---|
| 400 | system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| 400 | appqrcode_not_tinyapp | 非小程序类型 | 该接口当前仅支持小程序业务 |
| 400 | app_is_not_exist | 应用信息不存在 | 检查appid是否正确 |
| 400 | app_is_not_online | 业务异常应用不处于上线状态 | 请上线应用 |
| 400 | builded_not_by_template | 代关联的小程序版本不是基于模板构建的 | 代关联普通二维码的小程序必须是基于模板构建的 |
| 400 | host_verify_faild | 域名校验失败 | 检查域名是否合法，并且域名已正确校验 |
| 400 | invalid_param | 参数有误，输入参数非法 | 对照接口文档检查参数是否合法 |
| 400 | not_currently_avalialbe | 业务异常该功能尚未全量开放 | 联系技术人员，是否有资格使用该功能 |
| 400 | online_version_not_exist | 商户小程序没有线上版本 | 请上架商户小程序版本 |
| 400 | qrcode_host_route_num_limit | 该host下规则数量已达到上限 | 该host下规则数量已达到上限，需创建模式再绑定二维码 |
| 400 | qrcode_route_pattern_not_exist | 模式不存在 | 联系凯发app官方网站的技术支持人员，检查该模式是否存在 |
| 400 | qrcode_route_pattern_not_match | 业务异常规则和模式不匹配 | 检查规则和模式参数是否匹配 |
| 400 | qrcode_route_pattern_not_permission | 该模式无法用于绑定该小程序 | 联系凯发app官方网站的技术支持人员，检查是否有权限使用该模式 |
| 400 | qrcode_route_url_invalid | 业务异常二维码路由url非法 | 按照文档检查参数的格式 |
| 400 | route_create_need_version | 请先发布代码后再配置二维码规则 | 确保小程序已经创建过版本 |
| 400 | route_over_limit | 二维码模板已经超过个数限制 | 删除之前已绑定的无用二维码 |
| 400 | route_rule_conflict | 码路由规则冲突 | 更换url，确保未被绑定 |
| 400 | route_rule_conflict_other | 业务异常匹配模式已被其他小程序占用 | 更换规则 |
| 400 | secutiy_ssrf_url_faild | 网址访问失败 | 请确保route_url字段对应的网址能被访问 |
| 400 | secutiy_ssrf_url_illegal | 网址非法 | 请确保route_url字段有效 |
| 400 | template_mismatch_isvappid | 模板和三方应用关系不匹配 | 请重新上架基于模板构建的小程序版本, 该模板必须是自己三方应用下持有的模板 |
| 400 | template_not_have_host | 非模板名下持有域名 | 请到开放平台配置小程序模板普通二维码路由规则(域名必须相同) |