一、微信连接Wi-Fi业务介绍
微信连Wi-Fi是为商家的线下场所提供一套完整和便捷的微信连Wi-Fi的方案。商家接入微信连Wi-Fi后,顾客无需输入繁琐的Wi-Fi密码,通过微信扫二维码等方式即可快速上网。微信连Wi-Fi还帮助商家打造个性化服务,如提供微信顶部常驻入口、商家主页展示、连网后公众号下发消息等。因此,微信连Wi-Fi既可以极大的提升用户体验,又可以帮助商家提供精准的近场服务。
二、微信连Wi-Fi接口服务说明
2.1、概述
软件服务管理接口主要供具有开发能力的商家以及软件服务商调用。支持调用者管理商家公众号下的门店、Wi-Fi设备,配置用户连网方式和商家主页内容。同时支持接口获取WiFi数据统计,以及连网成功的开发者事件推送。
2.2、接口调用流程图
三、微信连Wi-Fi第三方平台插件开发
1、开通微信连Wi-Fi插件
调用微信连Wi-Fi其他所有接口的前提是已开通“微信连Wi-Fi”功能插件,目前开通插件共有两种方法:
1)在微信公众平台通过页面操作添加“微信连Wi-Fi“功能插件;
2)调用此接口开通第三方平台插件。
注:开通插件接口只支持公众号第三方平台调用,公众账号开发者请在微信公众平台自行开通。第三方平台接入,请参考微信开放平台。
2、第三方平台开通连Wi-Fi插件流程图
四、第三方平台接入微信连Wi-Fi详解步骤
1. 用户进入第三方平台网站并授权登录
用户需要先进入第三方平台网站,如www.ABC.com。第三方平台引导用户进行微信公众号授权登录操作。
2. 第三方平台获取开插件wifi_token
协议:https http请求方式: GET 请求URL:https://api.weixin.qq.com/bizwifi/openplugin/token?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "callback_url": "http://weixin.qq.com/" }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
callback_url | 是 | 回调URL,开通插件成功后的跳转页面。注:该参数域名必须与跳转进开通插件页面的页面域名保持一致,建议均采用第三方平台域名。 |
返回数据说明 正确返回JSON数据示例:
{ "errcode": 0, "data": { "is_open": true, "wifi_token": "" } }
字段说明:
字段 | 说明 |
---|---|
is_open | 该公众号是否已开通微信连Wi-Fi插件,true-已开通,false-未开通 |
wifi_token | 开通插件的凭证,当is_open为false时才返回值 |
3. 引导用户进入开通插件页面
第三方平台可以在自己的网页中放置“开通微信连Wi-Fi插件”的入口,引导用户进入开通插件页面。建议第三方平台采用“在当前页面打开“的形式打开开通插件页面。
网址为:https://wifi.weixin.qq.com/biz/mp/thirdProviderPlugin.xhtml?token=xxxx ,该网址中第三方平台需提供已获取的wifi_token。
4. 用户填写信息,开通插件
用户在开通插件页面填写相关信息,完成开通插件操作。
5. 跳转callback_url
用户开通插件成功后,网页将自动跳转到第三方平台调用“获取开通插件wifi_token”接口时提供的callback_url中,完成开通插件流程。之后第三方平台可以调用其他接口为用户提供微信连Wi-Fi服务。
五、配置微信连Wi-Fi的连网方式
获取二维码
添加设备后,通过此接口可以获取物料,包括二维码和桌贴两种样式。将物料铺设在线下门店里,可供用户扫码上网。
注:暂时只有密码型设备才可以下载二维码。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/qrcode/get?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620, "img_id": 1 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
img_id | 是 | 物料样式编号:0-纯二维码,可用于自由设计宣传材料;
1-二维码物料,155mm×215mm(宽×高),可直接张贴 |
物料样式:
(1) 示意图-纯二维码(img_id = 0)
(2) 示意图-二维码物料(img_id = 1)
返回数据说明 正确返回JSON数据示例:
{ "errcode": 0, "data": { "qrcode_url": "" } }
字段说明:
字段 | 说明 |
---|---|
qrcode_url | 二维码图片url |
获取公众号连网URL
将此URL配置在公众号菜单上,可供用户点击菜单一键连网。只有当公众号为认证号,且公众号内所有设备均为密码型设备时才可以获得。
接口调用说明
协议:https http请求方式: GET 请求URL:https://api.weixin.qq.com/bizwifi/account/get_connecturl?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
返回数据说明 正确返回JSON数据示例:
{ "errcode": 0, "data": { "connect_url": "" } }
字段说明:
字段 | 说明 |
---|---|
connect_url | 公众号连网的URL |
六、商家推广展示主页
设置商家主页
设置商户主页后,点击微信聊天窗口顶部常驻入口,即可进入设置的商户主页。可以设置默认模板和自定义url模板。注:认证的服务号和订阅号才能调用该接口设置。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/homepage/set?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
设置默认模板时: { "shop_id": 429620, "template_id": 0 } 设置自定义url模板: { "shop_id": 429620, "template_id": 1, "struct": { "url": "http://wifi.weixin.qq.com/" } }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
template_id | 是 | 模板ID,0-默认模板,1-自定义url |
struct | 否 | 模板结构,当template_id为0时可以不填 |
url | 否 | 自定义链接,当template_id为1时必填 |
查询商家主页
通过门店ID查询商户主页的信息。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/homepage/get?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 查询的门店id |
返回数据说明 正确返回JSON数据示例:
{ "errcode": 0, "data": { "shop_id": 429620, "template_id": 1, "url": " http://wifi.weixin.qq.com/" } }
字段说明:
字段 | 说明 |
---|---|
shop_id | 门店ID |
template_id | 模板类型 |
url | 商家主页链接 |
设置顶部常驻入口文案
设置微信首屏顶部常驻入口的文案,即选择“欢迎光临XXX”中的XXX显示公众号名称还是门店名称。
接口调用说明
协议:https http请求方式: POST 请求URL:https://api.weixin.qq.com/bizwifi/bar/set?access_token=ACCESS_TOKEN POST数据格式:JSON
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
POST数据 | 是 | JSON数据 |
POST数据
数据示例:
{ "shop_id": 429620, "bar_type": 1 }
字段说明:
字段 | 是否必填 | 说明 |
---|---|---|
shop_id | 是 | 门店ID |
bar_type | 是 | 顶部常驻入口上“欢迎光临XXX”的XXX内容,0-公众号名称,1-门店名称 |
评论