微信公众平台卡券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.团购优惠素材团购优惠png图片下载觅元素是设计素材的免费下载网站,提供团购优惠素材,团购优惠png图片等素材免费下载,下载团购优惠素材就来觅元素。https://www.51yuansu.com/sopng/tuangouyouhui.html
2.[团购优惠活动]图片免费下载团购优惠活动素材千图网为您找到67张团购优惠活动相关素材,千图网还提供团购优惠活动图片,团购优惠活动素材, 团购优惠活动模板等免费下载服务,千图网是国内专业创意营销服务交易平台,一站式解决企业营销数字化、协同化,实现营销转化效果增长!https://m.58pic.com/tupian/tuangouyouhuihuodong.html
3.团购大优惠图片团购大优惠设计素材红动中国素材网提供139个团购大优惠图片、团购大优惠素材、团购大优惠背景、团购大优惠模板、团购大优惠海报等PS素材下载,包含PSD、AI、PNG、JPG、CDR等格式源文件素材,更多精品团购大优惠设计素材下载,就来红动中国,最后更新于2024-11-26 13:04:39。https://so.redocn.com/youhui/cdc5b9bab4f3d3c5bbdd.htm
4....团购票价预定优惠南京侵华日军南京大屠杀遇难同胞纪念馆游玩攻略-侵华日军南京大屠杀遇难同胞纪念馆门票多少钱/价格表-团购票价预定优惠-景点地址在哪里/图片介绍/参观预约/旅游游览顺序攻略及注意事项/营业时间-【携程攻略】1/0 侵华日军南京大屠杀遇难同胞纪念馆4A今日08:30-17:00开放(16:30停止入园) 实用攻略 ? ...https://m.ctrip.com/html5/you/sight/19/10936.html
5.中秋礼品,阳澄湖大闸蟹礼品卡好多蟹 好多蟹,3.9折外卖,量大价优 给你购蟹无忧的便捷感 给你足斤足两的好品质 给你提蟹顺畅的服务体验 ?1378型及以上配蟹八件礼盒 蟹状元大闸蟹礼卡 图片为原价,特惠私聊,有量有价[OK] 一份起订,团购优惠,需要的联系 ...https://www.meipian.cn/4v5ua11g
6.大连老虎滩海洋公园>>极地馆门票团购,图片,电话大连老虎滩海洋公园门票★★▇█★优惠门票105元起★█▇★★,是大连唯一的国家五A级旅游景区,大连老虎滩公园门票团购,为游客提供优惠老虎滩极地馆门票预订,大连老虎滩门票,用最详尽的介绍,将大连著名的旅游景区展示给游客。http://laohutan.0411hd.com/
7.桂车界桂林汽车网桂林车市桂林汽车报价桂林汽车团购桂车界桂林生活网汽车频道为您提供最新的桂林车市行情、桂林汽车资讯、桂林汽车报价、降价信息,桂林二手车报价,桂林车展图片,桂林汽车论坛热贴及桂林汽车商家最新优惠促销信息,桂林4S店信息,桂林汽车团购服务等http://auto.guilinlife.com/
8.去哪儿网机票查询预订,酒店预订,旅游团购,度假搜索,门票预订...去哪儿Qunar.com提供机票,飞机票,特价机票,打折机票的查询预订;99元春秋航空特惠折扣机票,百元南航、海航惊喜特价机票任您挑选,国航、深航1折特价机票和折扣机票一网打尽,更多打折机票尽在Qunar.com。实时提供上百家旅游预订网站机票报价和航空公司直销机票价格,为您找http://qunar.com/
9.groupon台湾酷朋,全球最大团购集团,美食旅游宅配天天好康3折起Groupon推薦給您全台團購優惠,美食餐廳、吃到飽、各式餐券、電影票、門票展覽、SPA、美容、Yoga、旅遊飯店民宿、宅配購物等購物優惠3折起!吃喝玩樂找優惠,快上Groupon 酷朋!http://www.groupon.com.tw/
10.团购图片微信头像大全熊猫办公精心为用户挑选80张高清精美团购图片、支持专业级团购设计素材下载,更多风格的团购,免抠元素,卡通手绘素材图片、图标图案、免抠矢量图,尽在熊猫办公。https://www.tukuppt.com/speciall/tuangou8549.html
11.订餐小秘书订餐小秘书,上海最大最全餐饮指南,订餐电话57575777已成为家喻户晓的品牌.上海特色餐厅360度环视图,上海中高档饭店一站式网上订餐服务,网上订餐享团购优惠,200万会员的共同选择.http://www.57575777.com/
1.优惠团购素材优惠团购图片优惠团购素材图片下载觅知网为您找到291个原创优惠团购素材图片,包括优惠团购图片,优惠团购素材,优惠团购海报,优惠团购背景,优惠团购模板源文件下载服务,包含PSD、PNG、JPG、AI、CDR等格式素材,更多关于优惠团购素材、图片、海报、背景、插画、配图、矢量、UI、PS、免抠,模板、艺术字、Phttps://www.51miz.com/so-sucai/3338701.html
2.团购图片素材团购图片大全摄图网汇聚团购图片大全:团购素材、团购高清图片、团购背景图片等。你可以找团购设计灵感、摄影创意,我们欢迎您下载团购vrf正版授权图片,商用无压力https://m.699pic.com/image/tuangou.html
3.2024北京园博园门票预约入口+优惠政策+优惠团购2024北京园博园门票预约入口+优惠政策+优惠团购 北京园博园以一轴、两点、无园为主,整个景区内共有69个展园,传统、现代、创意、国际以及湿地展园呈现出不同的美景和建筑风格,游客们在每个展园都能观赏到不同美景,将园林风光尽收眼底。 北京园博园开放时间:3/15-10/31 06:30-19:00开放;11/1-3/14 07:...https://www.dahepiao.com/lvyounews1/20240322453401.html
4.《团购优惠正版23J909工程做法代替05J909国家设计标准图集中...团购优惠 正版 23J909 工程做法 代替05J909 国家设计标准图集 中国建筑标准设计研究院好上学图书专营店 登录查看更多图片 > 团购优惠 正版 23J909 工程做法 代替05J909 国... 京东价 ¥ 促销 展开促销 配送至 --请选择-- 支持 加入购物车 https://item.jd.com/10103984089822.html
5.抖音上打造本地团购达人速成方法,图文导购实操分享TaoKeShow抖音号【南京小吃货】:使用一张图片,固定音乐+图片3D运镜方式+背景音乐即可。 抖音号【羊毛雷达】:将套餐菜单单独列出,配上统一的背景音乐。 抖音号【南京团购优惠大全】:使用两张图片,配上热门音乐,卡点配上一些画面特效,突出最后一张图片:该套餐才多少多少钱。 https://www.taokeshow.com/55641.html
6.网络推广方案(精选17篇)HOW:用什么方法执行?如消费至多少可获赠品或价格优惠?(例如学员是3人还是5人、6人可以享受驾校的团购优惠价) HOW MUCH:支出多少?此次促销活动,需支出多少广告费?价值多少礼品?印刷费多少?需开支多少加班费?能增加多少新学员?能提升多少营业额?等等。 https://www.ruiwen.com/fangan/7050431.html
7.驼铃传奇梦驼铃门票,团购有优惠西安驼铃传奇门票座位图,驼铃传奇梦驼铃门票,团购有优惠西安驼铃传奇门票座位图, 会跑的实景演艺《驼铃传奇》秀,首创旋转行走式观众席,将现代高新科技与驼道丝路的传奇历史文化经典相融合,上演《驼铃传奇》秀的剧场中央巧妙设计并修建一座可移动观众席,可容纳3000人同时观看演出,打破了世界单一舞台演出模式,通过旋转行走看台将观众送至佳观演位置...https://www.cncn.com/xianlu/885145516901
8.店铺促销活动方案(通用15篇)推出适合手机特色的增殖服务,实行手机图片彩铃无限量自由免费下载(通过到指定销售店铺进行)。提高售后服务质量耐心讲解手机功能,提供覆盖面广的手机维修保养美化店铺。 二、团购优惠 团购就是客户购买多台手机或者是几个客户联合购买多台手机的时候,给予一定优惠的促销活动。 团购的让利可以吸引客户选择产品,客户普遍存在一...https://www.unjs.com/fanwenku/335547.html
9.店铺促销活动方案15篇推出适合手机特色的增殖服务,实行手机图片彩铃无限量自由免费下载(通过到指定销售店铺进行)。提高售后服务质量耐心讲解手机功能,提供覆盖面广的手机维修保养美化店铺。 二、团购优惠 团购就是客户购买多台手机或者是几个客户联合购买多台手机的时候,给予一定优惠的促销活动。 团购的让利可以吸引客户选择产品,客户普遍存在一...https://www.cnfla.com/huodongfangan/2985410.html
10.淘宝促销活动方案集锦16篇除了以上这些,常见的促销活动还有, 搭配套餐; 返还现金( 满m元,返还n元) ;拍卖:一元拍,荷兰拍; 团购; 优惠券; 会员制度营销 ; 赠送红包等,没有促销手段运用得当都能带来很好的转化率,如果你的某个宝贝能够上了活动,团购也好,天天特价也好,那么绝对会给你店铺带来可观的流量,在此上再做好店铺的搭配促销,可...https://www.jy135.com/chunxiaofangan/1276077.html
11.有哪些网站用爬虫爬取能得到很有价值的数据?容易爬取的数据网站玩法三:寻觅团购优惠和美食 玩法四:协助豆瓣打造个性化交友圈 玩法五:在百度地图上快速定位 玩法六:收集电商平台产品信息 玩法七:采集赶集网房源信息 玩法八:实时分析股票行情 玩法九:采集招聘网站职位信息 玩法十:高效收罗法律判决文书 实战 一、数据来源 https://blog.csdn.net/BC_COM/article/details/89851799
12.途观途观报价途观图片锦州途观优惠高达5.00万 仅14.48万可入手 廊坊途观价格最低13.98万起 优惠高达5.50万 景德镇途观最低16.48万起售 优惠高达3.00万 娄底途观价格14.98万起 优惠高达4.50万 长春途观优惠8.11万 仅12.66万可入手 车主实用工具 汽车报价 车型大全 车型图库 汽车视频 4S店大全 汽车团购 汽车销量 汽车排行 汽车投...https://www.16888.com/57414/
13.我的微长沙—长沙团购,长沙吃喝玩乐优惠平台,长沙便民服务平台长沙生活信息服务平台!提供长沙吃喝玩乐团购,长沙旅游信息,长沙招聘信息,长沙美食推荐,便民服务等实用信息!https://www.0731tg.com/
14.宁波杭州湾新区祥源漫城漫享主题商业街区,注入时尚人气活力热门楼盘推荐(点击以下图片或楼盘名称可进入楼盘详情页) 祥源漫城 杭州湾新区建面83-122㎡ 均价9500元/㎡ 团购优惠:组团砍价,得内部购房优惠立即领取 买房立减万元优惠(限楼盘网报名) 杭州湾绿地海湾 杭州湾新区建面75-125㎡ 均价13500元/㎡ 团购优惠:组团砍价,得内部购房优惠立即领取 ...https://m.loupan.com/nb/news/202107/4720304/
15.淘宝活动方案方式4:满就减,多买多优惠,买A送B,加X元送一件; 方式5:免费试用,赢免单。 促销的方式是很多,当然最主要的就是选择适合自己店铺的,而不要单单为了追求销量而盲目促销。 淘宝活动方案9 1、年龄要求:2-10岁,性别不限; 2、只要上传于小孩子上学相关的图片,即有机会获得奖品; ...https://www.wenshubang.com/fangan/2398856.html
16.MFA16666元现金 特等奖 品牌电动车 一等奖 三开门冰箱 二等奖 指纹行李箱 三等奖 品牌空调扇 四等奖 品牌电风扇 五等奖 品牌记忆枕 幸运奖 优惠多多 礼品多多 以上图片仅参考,具体以现场实物为准,最终解释权归本商场所有 地图路线 活动地址导航松...https://dl.beejia.cn/baopin/detail.php?id=110037