小程序开放平台

文档中心
授权小程序调用凭证
授权小程序码与链接
获取小程序二维码
获取小程序体验版二维码
获取不限制的小程序二维码
授权小程序管理
小程序代码与模板
服务商建联

获取小程序二维码

开发
>
服务端API
>
授权小程序码与链接
>
获取小程序二维码
>
更新时间:2024-11-18 14:58:12

获取小程序二维码

获取授权小程序的线上版二维码图片。

  • 此接口每个授权小程序每天只能生成 1000 个二维码。
  • 此接口生成的二维码必定存在时效性。

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/tp/auth/apps/qrcode

公共请求参数

名称
类型
是否必须
描述
appidstring服务商appid
auth_access_tokenstring授权小程序调用凭证

业务请求参数

名称
类型
是否必须
描述
widthinteger二维码宽度,单位 px,最小 280,最大 1280
page_urlstring扫码进入的小程序页面路径,根路径前不要添加 /,可携带 query,最大 1024 个字符
expire_intervalinteger失效间隔天数。生成的到期失效链接在该间隔时间到达前有效。最长间隔天数为 365 天,不填默认为 365 天

请求示例

{
  "width": 430,
  "page_url": "pages/index/index?a=1",
  "expire_interval": 30
}

返回说明

请求正常时会返回图像的字节流,响应 header 中包含

HTTP/1.1 200 OK

Content-Type: image/png

请求错误时会返回 JSON

{
  success: false,
  code: 2,
  msg: "系统异常,请稍后重试"
}