• 下载
  • 社区

小程序二维码

产品介绍

概述

使用本能力可生成小程序二维码,商户可将生成后的小程序二维码在线上线下进行贴码推广,更便捷地推广小程序。


产品特色

每个小程序都有一个默认的小程序二维码,目标地址是 小程序首页

  • 创建 20 个以内小程序二维码。开发中心 > 小程序应用 > 我的小程序 中点击已创建的小程序名称,进入小程序详情页面,左侧目录栏中选择 码管理 > 小程序码。
  • 创建超过 20 个小程序二维码。通过调用二维码接口 alipay.open.app.qrcode.create 实现,一个小程序可通过使用该二维码接口获取无限个带参数的二维码。


页面地址获取方式

小程序页面地址可通过开发者工具在代码中的 app.json 中的 onShow 和 onLaunch 中获取。


使用说明

支付宝扫描二维码将按以下匹配规则控制跳转:

  • 页面地址:指定小程序中能访问的路径地址,默认为小程序的首页地址。

  • 启动参数:小程序启动时候需要带入的参数,可以为空。启动参数可以通过 options.query 获取,格式为 key1=value1&key2=value2


示例代码

准备获取启动参数中 x 的值。


 1App({
 2  onLaunch(options) {
 3    my.alert({content: '启动参数:'+JSON.stringify(options.query.x),});
 4    console.log('query', options.query);
 5    console.log('App Launch', options);
 6  },
 7  onShow() {
 8    console.log('App Show')
 9  },
10  onHide() {
11    console.log('App Hide')
12  },
13  globalData: {
14    hasLogin: false
15  }
16})


输入参数

页面地址:page/component/component-pages/view/view

启动参数:x=1&y=2

示例效果:

image.png


准入条件

小程序开发者均可使用。


计费模式

不收费。


接入指引

第一步:创建小程序


若要在您的小程序内使用小程序二维码功能,您需要首先完成 开发者入驻 并 创建小程序


第二步:添加功能

小程序创建完成后,您可以在 开发管理 页 功能列表 部分点击 添加功能 来给创建的小程序添加功能,如下图所示。

勾选 小程序二维码 功能后,点击左下角 确定 即完成添加功能。
image.png


第三步:集成并配置 SDK


开发者需要调用开放平台 OpenAPI 接口获取二维码,推荐开发者使用开放平台 服务端 SDK。服务端 SDK 需要商户集成在自己的服务端系统中,用于后续的服务端接口调用。


下载服务端 SDK

为了帮助开发者调用开放接口,我们提供了 开放平台服务端 SDK,包含 JAVA、PHP、NodeJS、Python 和 .NET 五种语言,封装了签名 & 验签、HTTP 接口请求等基础功能。

请先下载对应语言版本的 SDK 并引入您的开发工程。


接口调用配置

在 SDK 调用前需要进行初始化,以 JAVA 代码为例:


1AlipayClient alipayClient = new DefaultAlipayClient(URL,APP_ID,APP_PRIVATE_KEY,FORMAT,CHARSET,ALIPAY_PUBLIC_KEY,SIGN_TYPE);


关键参数说明:

配置参数示例值解释获取方式/示例值
URL支付宝网关(固定) https://openapi.alipay.com/gateway.do 
APPIDAPPID 即创建应用后生成获取见 创建应用
APP_PRIVATE_KEY开发者私钥,由开发者自己生成获取见 配置密钥
FORMAT参数返回格式,只支持 jsonjson(固定)
CHARSET编码集,支持 GBK/UTF-8开发者根据实际工程编码配置
ALIPAY_PUBLIC_KEY支付宝公钥,由支付宝生成获取详见 配置密钥
SIGN_TYPE商户生成签名字符串所使用的签名算法类型,目前支持 RSA2 和 RSA,推荐使用 RSA2RSA2


接下来,就可以用 alipayClient 来调用具体的 API 了。

alipayClient 只需要初始化一次,后续调用不同的 API 都可以使用同一个 alipayClient 对象。


注意:

ISV /开发者可以通过 第三方应用授权 得到商户授权令牌(app_auth_token)作为请求参数传入,实现代商户发起请求的能力。


第四步:调用接口


在服务端接口调用 OpenAPI ,生成小程序推广二维码图片链接,JAVA 示例代码如下所示:


 1AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
 2AlipayOpenAppQrcodeCreateRequest request = new AlipayOpenAppQrcodeCreateRequest(); 
 3request.setBizContent("{" +
 4"\"url_param\":\"/index.html?name=ali&loc=hz\"," + "\"query_param\":\"name=1&age=2\"," + "\"describe\":\"二维码描述\"" +
 5" }");
 6AlipayOpenAppQrcodeCreateResponse response = alipayClient.execute(request); 
 7if(response.isSuccess()){
 8    System.out.println("调用成功");
 9} else {
10    System.out.println("调用失败");
11}


API 列表


接口名称

描述

alipay.open.app.qrcode.create

小程序生成推广二维码接口


如果您在调用 API 时出现报错,您可以:

  • 公共错误码 中根据错误码的类型,查找相关错误码及解决方案;
  • 在 小蚂哥 问答页面直接输入您遇到的错误码;
  • 在技术支持 帮助中心 搜索相关错误码,找到解决方案。