开发 服务端 获取小程序二维码
# 生成自定义小程序二维码
更新时间:2025-05-19 17:02:43
获取小程序的自定义二维码,二维码可通过快手/快手极速版扫码打开指定的小程序, 并传入开发者指定的参数。通过该接口生成的二维码永久生效。
开发者调用该接口来生成小程序二维码,返回二维码图片二进制的base64编码。
# 使用限制
小程序需含有对应的scope:scope.qrcode.create,该权限会在小程序基础信息(图标、描述、服务类目等信息)完善后自动赋予。
注:安卓端仅支持快手App和快手极速版扫码打开小程序,使用其他扫码方式可能无法打开。
# 接口基本信息
| 名称 | 描述 |
| HTTP URL | https://open.kuaishou.com/openapi/mp/qrcode/generate |
| HTTP Method | POST |
| Scope | scope.ks.qrcode |
| 权限要求 | 需要小程序已上线 拥有scope:scope.qrcode.create |
# 请求参数
请求头query参数
| 参数名 | 类型 | 是否必填 | 备注 |
| app_id | string | 是 | 小程序appId |
| access_token | string | 是 | 接口访问凭证, 如何获取参考:https://open.kuaishou.com/docs/develop/server/getAccessToken.html |
请求体body:
| 参数名 | 类型 | 是否必填 | 备注 |
| path | string | 否 | 指定小程序页面路径,会校验是否存在,可在path后加query类参数 |
| width | int | 否 | 二维码宽度,单位 px,最小不小于64,最大不大于1000,默认430 |
| set_icon | bool | 否 | 二维码中间是否展示小程序logo,默认为展示 |
| background | struct | 否 | 二维码背景,默认白色,RGB格式: { "r": 255, "g": 255, "b": 255 }
|
| line_color | struct | 否 | 二维码线条颜色,默认黑色 RGB格式: { "r": 0, "g": 0, "b": 0 } |
# 响应参数
Body
{
"result": 0,
"error_msg": "",
"data": {
"img": "#######" //二维码图片二进制的base64编码
}
}
# 错误码
| 状态码 | 错误码 | 错误码描述 | 排查建议 |
| 200 | 200100 | 应用不是小程序 | 检查参数必填字段和类型 |
| 200 | 200100 | 小程序未上线 | 小程序名称异常 |
| 200 | 200102 | beyond token scope | token中缺少对应scope,重新获取access_token |
| 200 | 200100 | 二维码大小不合法 | 重新设置合理二维码大小 |
| 200 | 200100 | 页面路径不合法 | 重新设置有效的路径 |
| 200 | 200410 | 频率超出限制 | 稍后重试 |
上一篇:《获取流量数据》
下一篇:《整体说明》
仍有疑问? 前往社区提问