微信公众平台卡券API接口开发指南

开通VIP,畅享免费电子书等14项超值服

首页

好书

留言交流

下载APP

联系客服

2021.06.23

以下是卡券开发过程中需要了解的关键概念:

申请一个公众平台账号

公众号开发信息配置

填写服务器配置并验证有效性

下面详细介绍这3个步骤。

账号申请完成后,我们进入公众平台官网的开发-基本配置页面,首先完成公众号开发信息配置,包括启用开发者密码(AppSecret)和配置IP白名单

然后,继续下面的服务器配置点击修改配置按钮,填写服务器地址(URL)、Token和EncodingAESKey,其中

Token可由开发者可以任意填写,用作生成签名

该Token会和接口URL中包含的Token进行比对,因此填写的url地址内需要实现返回业务逻辑,下面会有代码示例,从而验证安全性)。

EncodingAESKey由开发者手动填写或随机生成,将用作消息体加解密密钥。

同时,开发者可选择消息加解密方式:

将token、timestamp、nonce三个参数进行字典序排序

将三个参数字符串拼接成一个字符串进行sha1加密

检验signature的PHP示例代码:

注意

配置好商户开发信息后,商户开发者可依据接口文档实现业务逻辑。

普通卡券包含:代金券、团购券、优惠券、折扣券、兑换券

普通卡券特点

注:以下示例针对普通卡券操作

access_token是公众号的全局唯一接口调用凭据,公众号调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效。

接口调用

请求参数

响应参数

{'access_token':'ACCESS_TOKEN','expires_in':7200}112.上传卡券Logo接口调用

HTTP请求方式:POST/FROM(表单形式提交Logo图片)

响应报文

适用场景

选择卡券背景适用色值

在创建卡券接口中将颜色名(如Color010)填入color字段。

经过上述步骤之后,我们可调用创建卡券接口来创建一类新的卡券,获取card_id。创建卡券成功并通过审核后,商家可以通过文档提供的其他接口将卡券下发给用户,每次成功领取,库存数量相应扣除。

HTTP请求方式:POST

请求参数说明

POST数据示例请参考扩展《卡券创建接口POST报文示例》

普通卡券字段示例会员卡字段示例POST数据格式如下

团购券

{'card':{'card_type':'GROUPON','groupon':{'base_info':{················},'advanced_info':{················},'deal_detail':'示例'}}}12345678910111213141234567891011121314参数名必填类型示例值描述card_type是string(24)GROUPON团购券类型。base_info是JSON结构见扩展《卡券创建接口POST报文示例》基本的卡券数据,见扩展《卡券基础信息base_info字段》,所有卡券类型通用。advanced_info否JSON结构见扩展《卡券创建接口POST报文示例》卡券高级信息字段,见扩展《卡券高级信息advanced_info》,所有卡券类型通用。deal_detail是string(3072)双人套餐\n-进口红酒一支。\n孜然牛肉一份。团购券专用,团购详情。代金券

折扣券

{'card':{'card_type':'DISCOUNT','discount':{'base_info':{················},'advanced_info':{················},'discount':30}}}12345678910111213141234567891011121314参数名必填类型示例值描述card_type是string(24)DISCOUNT折扣券类型。base_info是Json结构见扩展《卡券创建接口POST报文示例》基本的卡券数据,见扩展《卡券基础信息base_info字段》,所有卡券类型通用。advanced_info否JSON结构见扩展《卡券创建接口POST报文示例》卡券高级信息字段,见扩展《卡券高级信息advanced_info》,所有卡券类型通用。discount是int30折扣券专用,表示打折额度(百分比)。填30就是七折。兑换券

优惠券

{'card':{'card_type':'GENERAL_COUPON','general_coupon':{'base_info':{················},'advanced_info':{················},'default_detail':'优惠券专用,填写优惠详情'}}}12345678910111213141234567891011121314参数名必填类型示例值描述card_type是string(24)GENERAL_COUPON优惠券类型。base_info是Json结构见扩展《卡券创建接口POST报文示例》基本的卡券数据,见扩展《卡券基础信息base_info字段》,所有卡券类型通用。advanced_info否JSON结构见扩展《卡券创建接口POST报文示例》卡券高级信息字段,见扩展《卡券高级信息advanced_info》,所有卡券类型通用。default_detail是string(3072)音乐木盒。优惠券专用,填写优惠详情。卡券创建返回报文格式

高级字段为商户额外展示信息字段,非必填,但是填入某些结构体后,须填充完整方可显示:如填入text_image_list结构体时,须同时传入image_url和text,否则也会报错;

预存code模式的卡券须设置quantity为0,导入code后方可增加库存;

注意:最新版本卡券API接口已经不允许使用URL替代方案为小程序。

为了满足商户基于卡券本身的扩展诉求,允许卡券内页添加url跳转外链。带有的的字段有encrypt_code、card_id。

卡券投放类型有:二维码投放、JS-SDK投放、卡券货架投放、群发卡券

二维码方式投放,开发者可调用该接口生成一张卡券二维码供用户扫码后添加到卡券卡包。

POST数据示例

投放单张卡券(非自定义卡券code码无需指定code,非指定用户领取无需指定openid)

{'action_name':'QR_CARD','expire_seconds':1800,'action_info':{'card':{'card_id':'pFS7Fjg8kV1IdDz01r4SQwMkuCKc','code':'198374613512',//自定义Code码的卡券单张投放'openid':'oFS7Fjl0WsZ9AMZqrI80nbIq8xrA',//指定用户可领'is_unique_code':false,'outer_str':'12b'}}}1234567891011121312345678910111213投放多张卡券(一次最多填入5个card_id,否则报错)

POST参数说明

返回参数

注意事项

注意:

目前卡券货架仅支持非自定义code卡券,自定义code卡券需先调用导入code接口,将code导入才能正常使用;

由于卡券有审核要求,为方便公众号调试,可以设置一些测试账号,这些账号可领取未通过审核的卡券,体验整个流程。

调用接口

卡券API接口核销类型

线下核销:指用户到店后,出示二维码或者出示串码,由收银员完成核销动作,如扫码核销、机具核销等

1.查询Code接口

开发者在调用核销code接口之前调用查询code接口,并在核销之前对非法状态的code(如转赠中、已删除、已核销等)做出处理。

POST数据

返回数据(这里以check_consume=true为例)

正常状态

{'errcode':0,'errmsg':'ok','card':{'card_id':'pbLatjk4T4Hx-QFQGL4zGQy27_Qg','begin_time':1457452800,'end_time':1463155199},'openid':'obLatjm43RA5C6QfMO5szKYnT3dM','can_consume':true,'user_card_status':'NORMAL'}123456789101112123456789101112异常状态

2.核销Code接口

消耗code接口是核销卡券的唯一接口,开发者可以调用当前接口将用户的优惠券进行核销,该过程不可逆。

非自定义Code卡券POST数据为

{'code':'12312313'}123123自定义Code卡券的POST数据还需要code_id

返回数据

{'errcode':0,'errmsg':'ok','card':{'card_id':'pFS7Fjg8kV1IdDz01r4SQwMkuCKc'},'openid':'oFS7Fjl0WsZ9AMZqrI80nbIq8xrA'}1234567812345678参数名描述errcode错误码。errmsg错误信息。openid用户在该公众号内的唯一身份标识。card_id卡券ID。注意事项

仅支持核销有效状态的卡券,若卡券处于异常状态,均不可核销。(异常状态包括:卡券删除、未生效、过期、转赠中、转赠退回、失效);

自定义Code码(use_custom_code为true)的优惠券,在code被核销时,必须调用此接口。用于将用户客户端的code状态变更。自定义code的卡券调用接口时,post数据中需包含card_id,否则报invalidserialcode,非自定义code不需上报;

获取api-ticket

由于获取api_ticket的api调用次数非常有限,频繁刷新api_ticket会导致api调用受限,影响自身业务,开发者需在自己的服务存储与更新api_ticket。

数据示例

chooseCard拉取卡券

特别提醒

开发者特别注意:签名错误会导致拉取卡券列表异常为空,请仔细检查参与签名的参数有效性。

2.Code解码接口

Code解码接口支持两种场景:

商家获取choos_card_info后,将card_id和encrypt_code字段通过解码接口,获取真实code;

卡券内跳转外链的签名中会对code进行加密处理,通过调用解码接口获取真实code;

{'errcode':0,'errmsg':'ok','code':'751234212312'}1234512345参数名描述errcode错误码errmsg错误信息code解密后获取的真实Code码注意事项

只能解码本公众号卡券获取的加密code。

开发者若从url上获取到加密code,请注意先进行urldecode,否则报错。

encrypt_code是卡券的code码经过加密处理得到的加密code码,与code一一对应。

开发者只能解密本公众号的加密code,否则报错。

3.查询Code接口

参考上面线下核销—查询Code接口

4.核销Code接口

参考上面线下核销—核销Code接口

查询code接口,可以查询当前code是否可以被核销,并检查code状态。

当前可以被定位状态有:正常、已核销、转赠中、已删除、已失效、无效code

用于获取用户卡包里的,属于该appid下所有可用卡券,包括正常状态和异常状态。

注:

查询用户已领取的卡券需要用户在该商户公众平台的openId,不支持小程序的openId。

如何在小程序查看用户已领取的卡券?

用户在商户小程序内领取卡券,记录用户小程序的openId、领取卡券的card_id和code落地服务端;

通过card_id和code来关联对应用户的公众号的openId和小程序的openId;

删除卡券接口允许商户删除任意一类卡券。删除卡券后,该卡券对应已生成的领取用二维码、添加到卡包JSAPI均会失效。

卡券快速买单优点

可以通过手机公众号、电脑商户后台,轻松操作收款并查看核销记录,交易对账,并支持离线下载。

支持会员营销,二次营销,如会员卡交易送积分,抵扣积分,买单后赠券等。

该接口支持更新所有卡券类型的部分通用字段及特殊卡券(会员卡、飞机票、电影票、会议门票)中特定字段信息

调用该接口增减某张卡券的库存。

为了满足改票、退款等异常情况,可调用卡券失效接口将用户的卡券设置为失效状态。

开发者可调用该接口,查询某个card_id的创建信息,审核状态以及库存数量。

开发者可批量查询指定状态的卡券列表;

开发者准备一个具备卡券权限的公众号和认证后的小程序账号;

通过公众平台或者卡券API接口创建卡券,获取card_id

小程序内记录用户openid,用户领取的code以及card_id;

处理卡券领取事件,记录用户在公众号内的openId,以及用户领取的code及card_id;

步骤

注意:需要改用户所在商户公众平台的openId,不支持小程序openId,具体步骤可参考《如何在小程序内查看已领取卡券列表》

将返回的数据卡券列表,调用wx.openCard()打开某张/多张卡券查看和使用;

JS-SDK使用步骤

绑定域名

登陆公众平台,进入公众号设置—>功能设置填写JS接口安全域名(以便该域名内部有权限访问JSSDK接口)

引入JS文件在需要调用JS接口的页面,引入如下JS文件:

通过config接口注入权限验证配置

通过ready接口处理成功验证

通过error接口处理失败验证

将所有参数字符串拼接成一个字符串进行sha1加密,得到cardSign

cardExt本身是一个JSON字符串,是商户为该张卡券分配的唯一性信息,包含以下字段:

THE END
1.公众号网络购物小程序排行榜2024年11月29日日榜单排行小程序简介涉及文章篇数曝光量对应公众数操作 1 睿意生活馆 省钱 省时 省事 省心 8 739672 1 详情 2 快团团 快团团,社群团购小程序。包含接龙、...8 中国邮政商城 中国邮政集团有限公司官方小程序,为用户提供买邮票邮品、订报刊杂志,看直播、享优惠等服务。 29 207216 9 详情 9 泡泡玛特抽盒机 POPMART...https://data.xiguaji.com/MiniAppRank/42/1/20241129.html
2.对接微信公众号/小程序,会员可随时查看消费积分等信息储值优惠券...顾客通过手机注册成为门店会员,无需到店,无需实体会员卡,随时随地可享受会员所有权益;微信公众号/小程序会员中心支持查询消费信息、积分明细、储值余额、套餐剩余等情况,还能在线充值、在线预约、在线购票、领取优惠券、参与转介绍等操作。帮助商家实现精准营销,简单易用,功能强大。https://www.163.com/dy/article/JI66IE58055649CC.html
3.在海韵之星公众号里团购的优惠券,以前来过在海韵之星公众号里团购的优惠券,以前来过一次,感觉还不错,这次由于疫情的原因,门口增设了进门登记制度,要出示身份证、苏康码,以及微信扫码。 这是一家比较不错的休闲娱乐场所,里面汇集了洗浴中心、韩式汗蒸、游泳池、自助餐厅、棋牌室、休息大厅、咖啡厅等,在里面有吃有喝有玩的,非常的惬意。一张船票有12个小时...https://m.dianping.com/review/717734606
4.微信团购怎么做公众号怎么添加微信团购系统步骤一,我们要做微信团购系统的话我们需要准备一个微信公众号,最好是认证服务号,然后是需要开通微信支付,然后是注册自橙一派网站,注册之后就可以绑定公众号了,完成之后就可以开始搭建微信团购系统了。 步骤二,功能管理-微信商城-微信团购系统-商品管理-添加团购,这边微信团购系统的模版是最简单的一个,适合我们商家想直...http://www.weixinrj.cn/news/huodong/1654.html
5....星际使命》影片体验电话《星际使命》影片体验公众号《星际...限量抢购,售罄为止! 微信扫描下方二维码查看团购详情抢购 《星际使命》影片体验【星际使命-单人票/星际使命-双人票/星际使命-三人票】最低仅需58元 进入沉浸式观影专辑页面,查看更多沉浸式观影团购活动! 更多优惠信息点击玩什么|吃什么|看什么,已购买如何查看订单?https://www.qianggen.net/tuan/0811761010/index.html
6.太二酸菜鱼的微博11月18日 11:00 来自品牌号 已编辑 在太二只有1%的人知道的省钱技巧: 1.美团大众点评抖音都有团购优惠 2.每月2/22号公众号会发菜品优惠券 3.官方直播间有福袋、代金券、秒杀品福利 4.太二酸菜鱼官方微博和小红书有抽霸王餐 5.酸菜鱼有小份、中份、大份三个选择 6.生日有送酸菜鱼-38元券和生日面 ....https://weibo.com/p/1006066167837994/home
7.微信小程序结合公众号前后端全栈开发微信优惠卡券星辰cd就拿优惠券开发这块来说,微信开发者文档解释很简陋,并且还要引用关联公众号的相关配置。刚好上个项目开发了微信小程序卡券功能,所以萌生了写这么一个教程的想法,一来担心自己久了遗忘,记录一下未来用到的时候可供翻阅,二来也能提供给需要的朋友,希望能够帮助的到大家。https://www.cnblogs.com/xochin001/p/12775536.html
8.吃喝玩乐分销推广–公众号/特价门票/亲子游/团购/活动网–新...大家好,这里整理石家庄本地特价的吃喝玩乐游平台,每个都非常的实惠,通过下面二维码加入后,在特惠的价格基础上还可以再有返利,不管是自购还是分享都可以有同等的收益!欢迎大家早日加入体验!免费加入! 美团圈圈 微信扫描或手机截图下面二维码在微信中扫一扫选择此图,根据提示快速免费加入 ...http://xinqi163.com/
9.商家如何利用微信来做会员营销?当某商家启用公众号微信会员卡后,顾客先关注公众号,然后注册微信电子会员卡。公众号本身就是一个商家对外展示企业形象的窗口,商家通过微信公众号上的群发功能,推送自己的企业文化、门店促销信息等,只要是注册了微信会员卡的顾客,都能第一时间接收到微信推送的图文信息,甚至音频视频信息,既形象又生动的公众号富媒体平台,...http://www.weixincd.com/jieda/5262.html
10.微信公众号开发微官网微分销微商城微活动微预约微投票咕噜管家,全能型第三方公众号服务平台,国内领先的微信开发服务商,微信公众平台。主要提供微信公众号二次开发,微信公众号建设。包含:微官网,微商城,微餐饮,人人分销,微酒店,微汽车,微团购,微众筹,微旅游,微房产,微拍卖,微教育,微投票等,一站式微信公众号运营托管http://niyuyi.cn/
11.票票在线公众号是自己的,粉丝是自己的 避免了依靠第三方及团购导流,形成依赖 数据优势 大数据是用户资源与信息 精准获取用户位置,消费习惯,消费周期 为营销系统和分析系统提供数据资源 营销优势 一个会营销的平台 支持分销价格及多级价络体系 支持分销推广佣金及优惠券营销系统 ...https://www.piao-piao.cn/
12.微信会员卡管理系统功能列表16、小票机类型选择 17、自助扫码买单开关 18、公众号模板消息行业类型初始化 19、实体卡绑定开关 20、实体卡验证开关 21、现金收款强制选择 微信卡券(创建)管理 1、微信卡券(同步微信卡包) 2、代金券 3、兑换券 4、折扣券 5、团购券 5、优惠券 7、卡券创建 8、商户名称与LOGO 9、券名称(标题)设置...http://www.kaxibao.com/gongneng/
13.爱宝云收银(零售行业企业版)功能简介消息推送 公众号推送会员消费信息 推广数据 推广邀请好友获取佣金、查看佣金明细、提现明细、生成推广海报 会员活动 会员续费、团购秒杀、每日领券、推广商品和积分兑换储值卡余额/商品/优惠券/次卡 拼团/秒杀 拼团列表 拼团活动设置、拼团活动汇总预览 拼团订单/详情 拼团订单查询 拼团效果统计 拼团/团购数据汇总统计 秒...http://blog.aibaocloud.com/article/101.html
1.领淘宝优惠券的公众号推荐(淘宝优惠券公众号推荐指南)淘宝优惠券公众号是广大消费者朋友们在网购过程中,省钱购物的好帮手。在这里,我们为您推荐一些信誉好、优惠力度大的淘宝优惠券公众号,让您在享受购物乐趣的同时,还能省钱购物! 一、淘宝优惠券公众号简介 淘宝优惠券公众号是一种专门发布淘宝优惠券、促销活动的公众号。关注这些公众号,您可以第一时间获取淘宝网的优惠...https://www.jianshu.com/p/ddda8474d725
2.团购网站大全:精选各类团购平台,一网打尽所有优惠信息导读随着互联网的快速发展,团购网站成为了人们日常生活中寻找优惠信息的重要途径之一。然而,市面上的团购网站琳琅满目,让人眼花缭乱。为了帮... 随着互联网的快速发展,团购网站成为了人们日常生活中寻找优惠信息的重要途径之一。然而,市面上的团购网站琳琅满目,让人眼花缭乱。为了帮助大家更好地了解和使用团购网站,我们...https://www.luyouqiwang.cn/qczx/202412/737468.html
3.乐岛门票,乐岛,团购,打折,门票,北戴河乐岛,2024年旺季180元淡季...请您先关注公众号(beidaihe186),然后通过微信告诉我们您一行人数,年龄,时间,对哪些景点或游乐项目感兴趣,住宿要求,自驾车或火车等出行方式,年龄、兴趣爱好等,我们会帮您预订好方便适合的住宿宾馆酒店家庭旅馆,各景点的团购打折门票,合适的吃海鲜、餐饮地方,交通路线以及车辆等。例如到北戴河旅游好玩的是大海、沙滩等,而...https://www.beidaihe186.com/jd_ledao3.php
4.龙哥风向标20230411~20230418GPT拆解百万免费无资源广告下载在私域群内提供优惠券或其丨他福利,吸引客户参与 在私域群内进行产品介绍、销丨售等活动 所需软件: 电丨话营销软件:例如阿里云通信、腾丨讯云通讯等 电丨话机器人软件:例如阿里云智能语音、讯飞开放平台等 私域群管丨理软件:例如微信、企业微信等 私域营销工具:例如微信小程序、微信公众号等 ...https://blog.csdn.net/wizardforcel/article/details/135933078
5.微擎小程序社群团购接龙V9.8.0小程序+公众号双端源码,后台...公众号应用·6年前 (2018-11-27) 社群团购接龙 124510 源码介绍 社群团购接龙系统秉承中心化思想,为微商个人/团队/公司,提供搭建去中心化销售平台系统解决方案。 一、社群团购系统特色 1、平台无买家下单入口,买家需通过代理商家分享的链接进入下单界面; https://www.wazyb.com/9229.html
6.武汉最受欢迎的8个公众号武汉房产官方公众号,楼市动态,楼盘优惠,开盘楼盘发布,性价比高的楼盘推荐!房产信息服务,为购房者买房置业提供决策参考! 武汉团购 武汉吃,喝,玩,乐,购,游团购,有武汉最优惠的团购信息!分享武汉新鲜事! 武汉楼市发布 权威的楼市资讯,开盘楼盘发布,性价比高的楼盘推荐!有楼市干货.在这里可以读懂市场,识破套路,买到称心...https://www.douban.com/note/724380699/
7.图文详解如何在微信公众号里实现拼团活动手机软件软件教程以上就是微信公众号拼团活动怎么做的具体方法,微信拼团活动的好处很多,可以是推广,任何商家,无论是知名度高还是低都需要推广,让更多的人来认识品牌和商店。还有清理库存,由于很多商品都有库存,团购可以使得库存大大减少,加快资金的回流。只要凑够人数进来购买商品,所有商品都能享受拼团优惠价,且拼团人数越多,拼团优惠...https://www.jb51.net/softjc/613900.html
8.OIS澳洲亲子团购–欢迎关注微信公众号:OISgroupbuy因一些亲们急需Attipas的鞋子,赶紧来开一团,但供应商的库存情况很不好,很都款都缺货了,这次团购的款,已经把所有有货的款式和尺寸标出来,请大家选购的时候注意一下编号旁边的尺寸,如果编号旁边没有标尺寸的,说明这款产品所有尺寸都有货。本次团购周三(5月17日)晚十二点截团。https://oisaushopping.wordpress.com/
9.湖北旅游惠民卡优惠活动来袭!仅需300元!湖北旅游惠民卡团购价格:300元起 在线订票:https://www.dahepiao.com/jingqulvyou1/20220915296964.html 欢迎关注公众号:大河票务网ID:dahepw,获取最新湖北旅游惠民卡门票价格。 欢迎在各大应用商城搜索下载【大河票务APP】,购票更便捷,更优惠! 湖北旅游惠民卡(湖北文旅一卡通旗下年卡) ...https://m.dahepiao.com/news/20230616394281.html