接口说明
接口英文名称:alipay.open.app.qrcode.create
请求url:https://openapi.alipay.com/v3/alipay/open/app/qrcode/create
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
生成小程序推广二维码
公共请求参数
业务请求参数
body参数
url_param|跳转小程序的页面路径必选string[1,256]
【描述】page/component/component-pages/view/view为小程序中能访问到的页面路径
【示例值】page/component/component-pages/view/view
query_param|小程序的启动参数必选string[1,256]
【描述】小程序启动参数,内容按照格式为参数名=参数值&参数名=参数值。打开小程序的query ,在小程序 onlaunch的方法中获取。可查看 如何获取各种场景的启动参数。
【示例值】key1=value1&key2=value2
describe|码描述必选string[1,32]
【描述】对应的二维码描述
【示例值】二维码描述
color|码颜色可选string[1,16]
【描述】圆形二维码颜色(十六进制颜色色值),仅圆形二维码支持颜色设置,方形二维码默认为黑色。
【示例值】0x00bfff
size|合成后图片的大小可选string[1,16]
【描述】合成后图片的大小规格,有s、m、l三档可选。
【枚举值】
8cm大小: s
12cm大小: m
30cm大小: l
【示例值】s
常见请求示例
推荐示例
默认示例
curl -x post \
"https://openapi.alipay.com/v3/alipay/open/app/qrcode/create" \
-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 '{
"url_param":"page/component/component-pages/view/view",
"query_param":"x=1",
"describe":"二维码描述"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
qr_code_url|方形二维码图片链接地址必选string(1024)
【描述】方形二维码图片链接地址
【示例值】http://mmtcdp.stable.alipay.net/wsdk/img?fileid=a*lsbpt5i9c1waaaaaaaaaaabjaqaaaa&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&
qr_code_url_circle_white|白底圆码链接地址可选string(256)
【描述】圆形二维码地址,白色slogan
【示例值】https://mdgwdev.alipay.net/wsdk/img?fileid=a*frfsrq-nxbkaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h
qr_code_url_circle_blue|蓝底圆码链接地址可选string(256)
【描述】圆形二维码地址,蓝色slogan
【示例值】https://mdgwdev.alipay.net/wsdk/img?fileid=a*kufuqrwzfdsaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h
响应示例
正常示例
异常示例
{
"qr_code_url":"http://mmtcdp.stable.alipay.net/wsdk/img?fileid=a*lsbpt5i9c1waaaaaaaaaaabjaqaaaa&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&",
"qr_code_url_circle_white":"https://mdgwdev.alipay.net/wsdk/img?fileid=a*frfsrq-nxbkaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h",
"qr_code_url_circle_blue":"https://mdgwdev.alipay.net/wsdk/img?fileid=a*kufuqrwzfdsaaaaaaaaaaaaaaqaaaq&bz=am_afts_openhome&zoom=800w_800h"
}
说明:本示例仅供参考。
公共错误码
前往查看业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
400 | invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
400 | hm_bg_color_invalid | 小程序码背景颜色非法 | 小程序码背景颜色非法,请检查输入颜色代码是否合法 |
400 | qrcode_desc_check_invalid | 小程序码描述含违规信息 | 小程序码描述含违规信息,请修改小程序码描述 |