me.chanjar.weixin.mp.api.impl

类 WxMpCardServiceImpl

java.lang.Object

me.chanjar.weixin.mp.api.impl.WxMpCardServiceImpl

所有已实现的接口:

WxMpCardService

public class WxMpCardServiceImpl
extends Object
implements WxMpCardService

Created by Binary Wang on 2016/7/27.

作者:

BinaryWang

构造器概要

构造器

构造器和说明
WxMpCardServiceImpl()

方法概要

限定符和类型	方法和说明
String	addTestWhiteList(String openid) 添加测试白名单.
String	consumeCardCode(String code) 卡券Code核销。
String	consumeCardCode(String code, String cardId) 卡券Code核销。
WxMpCardCreateResult	createCard(WxMpCardCreateMessage cardCreateMessage) 创建卡券.
WxCardApiSignature	createCardApiSignature(String... optionalSignParam) 创建调用卡券api时所需要的签名.
WxMpCardLandingPageCreateResult	createLandingPage(WxMpCardLandingPageCreateRequest request) 创建卡券货架.
WxMpCardQrcodeCreateResult	createQrcodeCard(String cardId, String outerStr) 创建卡券二维码.
WxMpCardQrcodeCreateResult	createQrcodeCard(String cardId, String outerStr, int expiresIn) 创建卡券二维码.
WxMpCardQrcodeCreateResult	createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid, String code, boolean isUniqueCode) 创建卡券二维码.
String	decryptCardCode(String encryptCode) 卡券Code解码.
WxMpCardDeleteResult	deleteCard(String cardId) 删除卡券接口.
String	getCardApiTicket() 获得卡券api_ticket，不强制刷新卡券api_ticket.
String	getCardApiTicket(boolean forceRefresh) 获得卡券api_ticket.
String	getCardDetail(String cardId) 查看卡券详情接口.
WxMpService	getWxMpService() 得到WxMpService.
void	markCardCode(String code, String cardId, String openId, boolean isMark) 卡券Mark接口.
WxMpCardResult	queryCardCode(String cardId, String code, boolean checkConsume) 卡券Code查询.
String	unavailableCardCode(String cardId, String code, String reason) 将用户的卡券设置为失效状态.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WxMpCardServiceImpl

public WxMpCardServiceImpl()

方法详细资料

getWxMpService

public WxMpService getWxMpService()

从接口复制的说明: WxMpCardService

得到WxMpService.

指定者:

getWxMpService 在接口中 WxMpCardService

返回:

WxMpService

getCardApiTicket

public String getCardApiTicket()
                        throws WxErrorException

从接口复制的说明: WxMpCardService

获得卡券api_ticket，不强制刷新卡券api_ticket.

指定者:

getCardApiTicket 在接口中 WxMpCardService

返回:

卡券api_ticket

抛出:

WxErrorException - 异常

另请参阅:

WxMpCardService.getCardApiTicket(boolean)

getCardApiTicket

public String getCardApiTicket(boolean forceRefresh)
                        throws WxErrorException

从接口复制的说明: WxMpCardService

 获得卡券api_ticket.
 获得时会检查卡券apiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94.9F.E6.88.90.E7.AE.97.E6.B3.95
 

指定者:

getCardApiTicket 在接口中 WxMpCardService

参数:

forceRefresh - 强制刷新

返回:

卡券api_ticket

抛出:

WxErrorException - 异常

createCardApiSignature

public WxCardApiSignature createCardApiSignature(String... optionalSignParam)
                                          throws WxErrorException

从接口复制的说明: WxMpCardService

 创建调用卡券api时所需要的签名.

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD
 .954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94
 .9F.E6.88.90.E7.AE.97.E6.B3.95
 

指定者:

createCardApiSignature 在接口中 WxMpCardService

参数:

optionalSignParam - 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id
注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空

返回:

卡券Api签名对象

抛出:

WxErrorException - 异常

decryptCardCode

public String decryptCardCode(String encryptCode)
                       throws WxErrorException

从接口复制的说明: WxMpCardService

卡券Code解码.

指定者:

decryptCardCode 在接口中 WxMpCardService

参数:

encryptCode - 加密Code，通过JSSDK的chooseCard接口获得

返回:

解密后的Code

抛出:

WxErrorException - 异常

queryCardCode

public WxMpCardResult queryCardCode(String cardId,
                                    String code,
                                    boolean checkConsume)
                             throws WxErrorException

从接口复制的说明: WxMpCardService

卡券Code查询. 文档地址： https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=1

指定者:

queryCardCode 在接口中 WxMpCardService

参数:

cardId - 卡券ID代表一类卡券

code - 单张卡券的唯一标准

checkConsume - 是否校验code核销状态，填入true和false时的code异常状态返回数据不同

返回:

WxMpCardResult对象

抛出:

WxErrorException - 异常

consumeCardCode

public String consumeCardCode(String code)
                       throws WxErrorException

从接口复制的说明: WxMpCardService

卡券Code核销。核销失败会抛出异常

指定者:

consumeCardCode 在接口中 WxMpCardService

参数:

code - 单张卡券的唯一标准

返回:

调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。

抛出:

WxErrorException - 异常

consumeCardCode

public String consumeCardCode(String code,
                              String cardId)
                       throws WxErrorException

从接口复制的说明: WxMpCardService

卡券Code核销。核销失败会抛出异常.

指定者:

consumeCardCode 在接口中 WxMpCardService

参数:

code - 单张卡券的唯一标准

cardId - 当自定义Code卡券时需要传入card_id

返回:

调用返回的JSON字符串。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。

抛出:

WxErrorException - 异常

markCardCode

public void markCardCode(String code,
                         String cardId,
                         String openId,
                         boolean isMark)
                  throws WxErrorException

从接口复制的说明: WxMpCardService

卡券Mark接口. 开发者在帮助消费者核销卡券之前，必须帮助先将此code（卡券串码）与一个openid绑定（即mark住）， 才能进一步调用核销接口，否则报错。

指定者:

markCardCode 在接口中 WxMpCardService

参数:

code - 卡券的code码

cardId - 卡券的ID

openId - 用券用户的openid

isMark - 是否要mark（占用）这个code，填写true或者false，表示占用或解除占用

抛出:

WxErrorException - 异常

getCardDetail

public String getCardDetail(String cardId)
                     throws WxErrorException

从接口复制的说明: WxMpCardService

查看卡券详情接口. 详见 https://mp.weixin.qq.com/wiki/14/8dd77aeaee85f922db5f8aa6386d385e.html#.E6.9F.A5.E7.9C.8B.E5.8D.A1.E5.88.B8.E8.AF.A6.E6.83.85

指定者:

getCardDetail 在接口中 WxMpCardService

参数:

cardId - 卡券的ID

返回:

返回的卡券详情JSON字符串
[注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。
可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。

抛出:

WxErrorException - 异常

addTestWhiteList

public String addTestWhiteList(String openid)
                        throws WxErrorException

从接口复制的说明: WxMpCardService

添加测试白名单.

指定者:

addTestWhiteList 在接口中 WxMpCardService

参数:

openid - 用户的openid

返回:

string

抛出:

WxErrorException - 异常

createCard

public WxMpCardCreateResult createCard(WxMpCardCreateMessage cardCreateMessage)
                                throws WxErrorException

从接口复制的说明: WxMpCardService

创建卡券.

指定者:

createCard 在接口中 WxMpCardService

参数:

cardCreateMessage - 请求

返回:

result

抛出:

WxErrorException - 异常

createQrcodeCard

public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                                   String outerStr)
                                            throws WxErrorException

从接口复制的说明: WxMpCardService

创建卡券二维码.

指定者:

createQrcodeCard 在接口中 WxMpCardService

参数:

cardId - 卡券编号

outerStr - 二维码标识

返回:

WxMpCardQrcodeCreateResult

抛出:

WxErrorException - 异常

createQrcodeCard

public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                                   String outerStr,
                                                   int expiresIn)
                                            throws WxErrorException

从接口复制的说明: WxMpCardService

创建卡券二维码.

指定者:

createQrcodeCard 在接口中 WxMpCardService

参数:

cardId - 卡券编号

outerStr - 二维码标识

expiresIn - 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效

返回:

WxMpCardQrcodeCreateResult

抛出:

WxErrorException - 异常

createQrcodeCard

public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                                   String outerStr,
                                                   int expiresIn,
                                                   String openid,
                                                   String code,
                                                   boolean isUniqueCode)
                                            throws WxErrorException

从接口复制的说明: WxMpCardService

创建卡券二维码.

指定者:

createQrcodeCard 在接口中 WxMpCardService

参数:

cardId - 卡券编号

outerStr - 用户首次领卡时，会通过 领取事件推送 给商户； 对于会员卡的二维码，用户每次扫码打开会员卡后点击任何url，会将该值拼入url中，方便开发者定位扫码来源

expiresIn - 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效

openid - 指定领取者的openid，只有该用户能领取。bind_openid字段为true的卡券必须填写，非指定openid不必填写。

code - 卡券Code码,use_custom_code字段为true的卡券必须填写，非自定义code和导入code模式的卡券不必填写。

isUniqueCode - 指定下发二维码，生成的二维码随机分配一个code，领取后不可再次扫描。填写true或false。默认false，注意填写该字段时，卡券须通过审核且库存不为0。

返回:

WxMpCardQrcodeCreateResult

抛出:

WxErrorException - 异常

createLandingPage

public WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest request)
                                                  throws WxErrorException

从接口复制的说明: WxMpCardService

创建卡券货架.

指定者:

createLandingPage 在接口中 WxMpCardService

参数:

request - 货架创建参数

返回:

WxMpCardLandingPageCreateResult

抛出:

WxErrorException - 异常

unavailableCardCode

public String unavailableCardCode(String cardId,
                                  String code,
                                  String reason)
                           throws WxErrorException

从接口复制的说明: WxMpCardService

将用户的卡券设置为失效状态. 详见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=9

指定者:

unavailableCardCode 在接口中 WxMpCardService

参数:

cardId - 卡券编号

code - 用户会员卡号

reason - 设置为失效的原因

返回:

result

抛出:

WxErrorException - 异常

deleteCard

public WxMpCardDeleteResult deleteCard(String cardId)
                                throws WxErrorException

从接口复制的说明: WxMpCardService

删除卡券接口.

指定者:

deleteCard 在接口中 WxMpCardService

参数:

cardId - 卡券id

返回:

删除结果

抛出:

WxErrorException - 异常