微信公众号开发之推广支持

2016-12-26 本文已影响2068人 Javen205

微信极速开发系列文章：点击喜欢不迷路

前几篇文章详细介绍了微信App支付、公众号支付、微信红包、微信刷卡以及支付宝支付,今天来聊聊 推广支持之生成带参数的二维码、长链接转短链接

目录
1、查看权限
2、生成带参数的二维码简介
3、接口说明
4、具体实现
5、测试
6、长链接转短链接

1、查看权限

登录微信公众平台 >开发>接口权限进行查看如下图

查看权限

2、生成带参数的二维码简介

为了满足用户渠道推广分析和用户帐号绑定等场景的需要，公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码，用户扫描后，公众号可以接收到事件推送。

【生成带参数的二维码官方介绍文档】

目前有2种类型的二维码：

1、临时二维码，是有过期时间的，最长可以设置为在二维码生成后的30天（即2592000秒）后过期，但能够生成较多数量。临时二维码主要用于帐号绑定等不要求二维码永久保存的业务场景

2、永久二维码，是无过期时间的，但数量较少（目前为最多10万个）。永久二维码主要用于适用于帐号绑定、用户来源统计等场景。

当用户扫描带场景值二维码时，可能推送以下两种事件：

如果用户 还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。

如果用户 已经关注公众号，在用户扫描后会自动进入会话，微信也会将带场景值扫描事件推送给开发者。

3、接口说明

获取带参数的二维码的过程包括两步，首先创建二维码ticket，然后凭借ticket到指定URL换取二维码。

创建二维码ticket
每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id），分别介绍临时二维码和永久二维码的创建二维码ticket过程。

临时二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：
{
  "expire_seconds": 604800,
  "action_name": "QR_SCENE",
  "action_info": {
    "scene": {
      "scene_id": 123
    }
  }
}

永久二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：
{
  "action_name": "QR_LIMIT_SCENE",
  "action_info": {
    "scene": {
      "scene_id": 123
    }
  }
}

或者也可以使用以下POST数据创建字符串形式的二维码参数：

{
  "action_name": "QR_LIMIT_STR_SCENE",
  "action_info": {
    "scene": {
      "scene_str": "123"
    }
  }
}

参数说明

参数	说明
expire_seconds	该二维码有效时间，以秒为单位。最大不超过2592000（即30天），此字段如果不填，则默认有效期为30秒。
action_name	二维码类型，QR_SCENE为临时,QR_LIMIT_SCENE为永久,QR_LIMIT_STR_SCENE为永久的字符串参数值
action_info	二维码详细信息
scene_id	场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
scene_str	场景值ID（字符串形式的ID），字符串类型，长度限制为1到64，仅永久二维码支持此字段

返回说明

正确的Json返回结果:

{
  "expire_seconds": 60,
  "ticket": "gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm3sUw==",
  "url": "http://weixin.qq.com/q/kZgfwMTm72WWPkovabbI"
}

参数	说明
ticket	获取的二维码ticket，凭借此ticket可以在有效时间内换取二维码。
expire_seconds	该二维码有效时间，以秒为单位。最大不超过2592000（即30天）。
url	二维码图片解析后的地址，开发者可根据该地址自行生成需要的二维码图片

通过ticket换取二维码
获取二维码ticket后，开发者可用ticket换取二维码图片。请注意，本接口无须登录态即可调用。

请求说明

HTTP GET请求（请使用https协议）https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
提醒：TICKET记得进行UrlEncode

返回说明

ticket正确情况下，http 返回码是200，是一张图片，可以直接展示或者下载。

HTTP头（示例）如下：
Accept-Ranges:bytes
Cache-control:max-age=604800
Connection:keep-alive
Content-Length:28026
Content-Type:image/jpg
Date:Wed, 16 Oct 2013 06:37:10 GMT
Expires:Wed, 23 Oct 2013 14:37:10 +0800
Server:nginx/1.4.1

错误情况下（如ticket非法）返回HTTP错误码404。

4、具体实现


/**
 * 生成带参数的二维码 API
 */
public class QrcodeApi
{
    private static String apiUrl = "https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=";
    
    public static ApiResult create(String jsonStr) {
        String jsonResult = HttpUtils.post(apiUrl + AccessTokenApi.getAccessTokenStr(), jsonStr);
        return new ApiResult(jsonResult);
    }
    
    /**
     * 创建临时二维码
     * @param expireSeconds 该二维码有效时间，以秒为单位。 最大不超过604800（即7天）。
     * @param sceneId 场景值ID，临时二维码时为32位非0整型
     * @return ApiResult 二维码信息
     */
    public static ApiResult createTemporary(int expireSeconds, int sceneId) {
        Map<String, Object> params = new HashMap<String, Object>();
        params.put("expire_seconds", expireSeconds);
        params.put("action_name", "QR_SCENE");
        
        Map<String, Object> actionInfo = new HashMap<String, Object>();
        Map<String, Object> scene = new HashMap<String, Object>();
        scene.put("scene_id", sceneId);
        
        actionInfo.put("scene", scene);
        params.put("action_info", actionInfo);
        return create(JsonUtils.toJson(params));
    }
    
    /**
     * 创建永久二维码
     * @param sceneId 场景值ID，永久二维码时最大值为100000（目前参数只支持1--100000）
     * @return ApiResult 二维码信息
     */
    public static ApiResult createPermanent(int sceneId) {
        Map<String, Object> params = new HashMap<String, Object>();
        params.put("action_name", "QR_LIMIT_SCENE");
        
        Map<String, Object> actionInfo = new HashMap<String, Object>();
        Map<String, Object> scene = new HashMap<String, Object>();
        scene.put("scene_id", sceneId);
        
        actionInfo.put("scene", scene);
        params.put("action_info", actionInfo);
        return create(JsonUtils.toJson(params));
    }
    
    /**
     * 创建永久二维码
     * @param sceneStr 场景值ID（字符串形式的ID），字符串类型，长度限制为1到64，仅永久二维码支持此字段
     * @return ApiResult 二维码信息
     */
    public static ApiResult createPermanent(String sceneStr) {
        Map<String, Object> params = new HashMap<String, Object>();
        params.put("action_name", "QR_LIMIT_STR_SCENE");
        
        Map<String, Object> actionInfo = new HashMap<String, Object>();
        Map<String, Object> scene = new HashMap<String, Object>();
        scene.put("scene_str", sceneStr);
        
        actionInfo.put("scene", scene);
        params.put("action_info", actionInfo);
        return create(JsonUtils.toJson(params));
    }
    
    private static String showQrcodeUrl = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=";
    
    /**
     * 通过ticket换取二维码地址
     * @param ticket 换取二维码参数
     * @return String url
     */
    public static String getShowQrcodeUrl(String ticket) {
        return showQrcodeUrl + ticket;
    }
}

封装接口说明：
1、QrcodeApi. create(String jsonStr) 自定义json参数生成二维码
2、QrcodeApi. createTemporary(int expireSeconds, int sceneId) 创建临时二维码，可自定义时间以及场景ID
3、QrcodeApi. createPermanent(int sceneId) 创建永久二维码，可自定义场景ID
4、QrcodeApi. createPermanent(String sceneStr) 创建永久二维码,可自定义场景值ID（字符串形式的ID）

5、测试

使用测试号进行测试,如果没有测试号可以【在此】申请

临时二维码

 public void getQrcode()
    {
        String str = "{\"expire_seconds\": 604800, \"action_name\": \"QR_SCENE\", \"action_info\": {\"scene\": {\"scene_id\": 123}}}";
        ApiResult apiResult = QrcodeApi.create(str);
        renderText(apiResult.getJson());
    }

如果没有权限则返回

{"errcode":48001,"errmsg":"api unauthorized hint: [Rkwbna0770rsz7!]"}

正确返回

{
  "expire_seconds": 604800,
  "ticket": "gQEd8DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyYXdOV2xWLTI5aVUxdWhWRXhvMWwAAgQRv19YAwSAOgkA",
  "url": "http://weixin.qq.com/q/02awNWlV-29iU1uhVExo1l"
}

使用第三方工具根据以上Urlhttp://weixin.qq.com/q/02awNWlV-29iU1uhVExo1l生成二维码

使用第三方工具根据Url生成二维码

使用微信扫码如果未关注将会跳转是关注页，点击关注则推送subscribe事件

<xml>
<ToUserName><![CDATA[gh_8746b7fa293e]]></ToUserName>
<FromUserName><![CDATA[ofkJSuGtXgB8n23e-y0kqDjJLXxk]]></FromUserName>
<CreateTime>1482670578</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[subscribe]]></Event>
<EventKey><![CDATA[qrscene_123]]></EventKey>
<Ticket><![CDATA[gQEd8DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyYXdOV2xWLTI5aVUxdWhWRXhvMWwAAgQRv19YAwSAOgkA]]></Ticket>
</xml>

使用微信扫码如果已关注将会向开发者推送扫码事件SCAN 如以下


<xml>
<ToUserName><![CDATA[gh_8746b7fa293e]]></ToUserName>
<FromUserName><![CDATA[ofkJSuGtXgB8n23e-y0kqDjJLXxk]]></FromUserName>
<CreateTime>1482670378</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[SCAN]]></Event>
<EventKey><![CDATA[123]]></EventKey>
<Ticket><![CDATA[gQEd8DwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyYXdOV2xWLTI5aVUxdWhWRXhvMWwAAgQRv19YAwSAOgkA]]></Ticket>
</xml>

生成永久二维码并使用ticket换取二维码

public void getQrcode2(){
        ApiResult apiResult = QrcodeApi.createPermanent(100);
        String qrcodeUrl = QrcodeApi.getShowQrcodeUrl(apiResult.getStr("ticket"));
        renderText("create>>"+apiResult.getJson()+" qrcodeUrl:"+qrcodeUrl);
    }

{
  "ticket": "gQFo8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0cwT21FZjNtM3RXbmd3REF6Ml82AAIEzyFQVwMEAAAAAA==",
  "url": "http://weixin.qq.com/q/G0OmEf3m3tWngwDAz2_6"
}

使用使用ticket换取二维码RUL
qrcodeUrl:https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQFo8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0cwT21FZjNtM3RXbmd3REF6Ml82AAIEzyFQVwMEAAAAAA==

直接浏览访问即可查看二维码，当然也可以下载到本地

使用`ticket`换取到的二维码

扫码后开发者响应的内容如下

<xml>
<ToUserName><![CDATA[gh_8746b7fa293e]]></ToUserName>
<FromUserName><![CDATA[ofkJSuGtXgB8n23e-y0kqDjJLXxk]]></FromUserName>
<CreateTime>1482671133</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[SCAN]]></Event>
<EventKey><![CDATA[100]]></EventKey>
<Ticket><![CDATA[gQFo8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0cwT21FZjNtM3RXbmd3REF6Ml82AAIEzyFQVwMEAAAAAA==]]></Ticket>
</xml>

如果是action_name值为QR_LIMIT_STR_SCENE为永久的字符串参数值则响应以下内容

<xml>
<ToUserName><![CDATA[gh_8746b7fa293e]]></ToUserName>
<FromUserName><![CDATA[ofkJSuGtXgB8n23e-y0kqDjJLXxk]]></FromUserName>
<CreateTime>1482671258</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[SCAN]]></Event>
<EventKey><![CDATA[Javen测试二维码]]></EventKey>
<Ticket><![CDATA[gQGm8TwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyMXdXUmtXLTI5aVUxMDAwMGcwN1IAAgSOxF9YAwQAAAAA]]></Ticket>
</xml>

6、长链接转短链接

将一条长链接转成短链接。
主要使用场景：开发者用于生成二维码的原链接（商品、支付二维码等）太长导致扫码速度和成功率下降，将原长链接通过此接口转成短链接再生成二维码将大大提升扫码速度和成功率。

接口调用请求说明

http请求方式: POST
https://api.weixin.qq.com/cgi-bin/shorturl?access_token=ACCESS_TOKEN

参数说明

参数	是否必须	说明
access_token	是	调用接口凭证
action	是	此处填long2short，代表长链接转短链接
long_url	是	需要转换的长链接，支持http://、https://、weixin://wxpay 格式的url

接口封装

/**
 * 将一条长链接转成短链接 API
 * 文档地址：http://mp.weixin.qq.com/wiki/6/d2ec191ffdf5a596238385f75f95ecbe.html
 */
public class ShorturlApi
{
    private static String apiUrl = "https://api.weixin.qq.com/cgi-bin/shorturl?access_token=";
    
    public static ApiResult getShorturl(String jsonStr) {
        String jsonResult = HttpUtils.post(apiUrl + AccessTokenApi.getAccessTokenStr(), jsonStr);
        return new ApiResult(jsonResult);
    }
    
    /**
     * 长链接转短链接接口
     * @param longUrl 需要转换的长链接，支持http://、https://、weixin://wxpay 格式的url
     * @return ApiResult 短连接信息
     */
    public static ApiResult getShortUrl(String longUrl) {
        Map<String, Object> params = new HashMap<String, Object>();
        params.put("action", "long2short");
        params.put("long_url", longUrl);
        return getShorturl(JsonUtils.toJson(params));
    }
}

测试

将我简书主页http://www.jianshu.com/users/9be31238fda1/latest_articles 转成短链接

/**
     * 长链接转成短链接
     */
    public void getShorturl()
    {
        String str = "{\"action\":\"long2short\"," +
                "\"long_url\":\"http://www.jianshu.com/users/9be31238fda1/latest_articles\"}";
        ApiResult apiResult = ShorturlApi.getShorturl(str);
        renderText(apiResult.getJson());
    }

浏览器测试http://localhost:8080/api/getShorturl 正确返回如下内容

{"errcode":0,"errmsg":"ok","short_url":"http://w.url.cn/s/Asx90AS"}

最终将我简书主页http://www.jianshu.com/users/9be31238fda1/latest_articles
转成短链接http://w.url.cn/s/Asx90AS

推荐阅读
Android版-微信APP支付
 极速开发微信公众号之微信买单
 极速开发微信公众号之公众号支付
 极速开发微信公众号之扫码支付
 极速开发微信公众号之刷卡支付
 极速开发微信公众号之现金红包
 Android版-支付宝APP支付
 支付宝Wap支付

记录学习的点滴，以此勉励不断奋斗的自己✌️✌️✌️ 如果对你有帮助记得点喜欢

源码下载地址