WxMpCardService (WxJava - MP Java SDK 3.4.0 API)

所有已知实现类:

WxMpCardServiceImpl
```
public interface WxMpCardService
```
卡券相关接口

作者:

YuJian(mgcnrx11 @ hotmail.com) on 01/11/2016, yuanqixun 2018-08-29

字段概要

字段
限定符和类型	字段和说明
`static String`	`CARD_CODE_CONSUME`
`static String`	`CARD_CODE_DECRYPT`
`static String`	`CARD_CODE_GET`
`static String`	`CARD_CODE_MARK`
`static String`	`CARD_CODE_UNAVAILABLE` 将用户的卡券设置为失效状态
`static String`	`CARD_CREATE`
`static String`	`CARD_DELETE` 卡券删除
`static String`	`CARD_GET`
`static String`	`CARD_GET_TICKET`
`static String`	`CARD_LANDING_PAGE_CREATE`
`static String`	`CARD_QRCODE_CREATE`
`static String`	`CARD_TEST_WHITELIST`

方法概要

All Methods Instance Methods Abstract Methods
限定符和类型	方法和说明
`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时所需要的签名详情请见：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
`WxMpCardLandingPageCreateResult`	`createLandingPage(WxMpCardLandingPageCreateRequest createRequest)` 创建卡券货架
`WxMpCardQrcodeCreateResult`	`createQrcodeCard(String cardId, String outerStr)` 创建卡券二维码
`WxMpCardQrcodeCreateResult`	`createQrcodeCard(String cardId, String outerStr, int expiresIn)` 创建卡券二维码
`String`	`decryptCardCode(String encryptCode)` 卡券Code解码
`WxMpCardDeleteResult`	`deleteCard(String cardId)` 删除卡券接口
`String`	`getCardApiTicket()` 获得卡券api_ticket，不强制刷新卡券api_ticket
`String`	`getCardApiTicket(boolean forceRefresh)` 获得卡券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
`String`	`getCardDetail(String cardId)` 查看卡券详情接口详见 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
`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)` 将用户的卡券设置为失效状态详见:https://mp.weixin.qq.com/wiki?

- 字段详细资料
  - CARD_CREATE
```
static final String CARD_CREATE
```
    另请参阅:
    
    常量字段值
  - CARD_GET
```
static final String CARD_GET
```
    另请参阅:
    
    常量字段值
  - CARD_GET_TICKET
```
static final String CARD_GET_TICKET
```
    另请参阅:
    
    常量字段值
  - CARD_CODE_DECRYPT
```
static final String CARD_CODE_DECRYPT
```
    另请参阅:
    
    常量字段值
  - CARD_CODE_GET
```
static final String CARD_CODE_GET
```
    另请参阅:
    
    常量字段值
  - CARD_CODE_CONSUME
```
static final String CARD_CODE_CONSUME
```
    另请参阅:
    
    常量字段值
  - CARD_CODE_MARK
```
static final String CARD_CODE_MARK
```
    另请参阅:
    
    常量字段值
  - CARD_TEST_WHITELIST
```
static final String CARD_TEST_WHITELIST
```
    另请参阅:
    
    常量字段值
  - CARD_QRCODE_CREATE
```
static final String CARD_QRCODE_CREATE
```
    另请参阅:
    
    常量字段值
  - CARD_LANDING_PAGE_CREATE
```
static final String CARD_LANDING_PAGE_CREATE
```
    另请参阅:
    
    常量字段值
  - CARD_CODE_UNAVAILABLE
```
static final String CARD_CODE_UNAVAILABLE
```
    将用户的卡券设置为失效状态
    
    另请参阅:
    
    常量字段值
  - CARD_DELETE
```
static final String CARD_DELETE
```
    卡券删除
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getWxMpService
```
WxMpService getWxMpService()
```
    得到WxMpService
  - getCardApiTicket
```
String getCardApiTicket()
                 throws WxErrorException
```
    获得卡券api_ticket，不强制刷新卡券api_ticket
    
    返回:
    
    卡券api_ticket
    
    抛出:
    
    WxErrorException
    
    另请参阅:
    
    getCardApiTicket(boolean)
  - getCardApiTicket
```
String getCardApiTicket(boolean forceRefresh)
                 throws WxErrorException
```
```
 获得卡券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
 
```
    参数:
    
    forceRefresh - 强制刷新
    
    返回:
    
    卡券api_ticket
    
    抛出:
    
    WxErrorException
  - createCardApiSignature
```
WxCardApiSignature createCardApiSignature(String... optionalSignParam)
                                   throws WxErrorException
```
```
 创建调用卡券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
 
```
    参数:
    
    optionalSignParam - 参与签名的参数数组。可以为下列字段：app_id, card_id, card_type, code, openid, location_id
    注意：当做wx.chooseCard调用时，必须传入app_id参与签名，否则会造成签名失败导致拉取卡券列表为空
    
    返回:
    
    卡券Api签名对象
    
    抛出:
    
    WxErrorException
  - decryptCardCode
```
String decryptCardCode(String encryptCode)
                throws WxErrorException
```
    卡券Code解码
    
    参数:
    
    encryptCode - 加密Code，通过JSSDK的chooseCard接口获得
    
    返回:
    
    解密后的Code
    
    抛出:
    
    WxErrorException
  - queryCardCode
```
WxMpCardResult queryCardCode(String cardId,
                             String code,
                             boolean checkConsume)
                      throws WxErrorException
```
    卡券Code查询. 文档地址： https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=1
    
    参数:
    
    cardId - 卡券ID代表一类卡券
    
    code - 单张卡券的唯一标准
    
    checkConsume - 是否校验code核销状态，填入true和false时的code异常状态返回数据不同
    
    返回:
    
    WxMpCardResult对象
    
    抛出:
    
    WxErrorException
  - consumeCardCode
```
String consumeCardCode(String code)
                throws WxErrorException
```
    卡券Code核销。核销失败会抛出异常
    
    参数:
    
    code - 单张卡券的唯一标准
    
    返回:
    
    调用返回的JSON字符串。
    可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    
    抛出:
    
    WxErrorException
  - consumeCardCode
```
String consumeCardCode(String code,
                       String cardId)
                throws WxErrorException
```
    卡券Code核销。核销失败会抛出异常
    
    参数:
    
    code - 单张卡券的唯一标准
    
    cardId - 当自定义Code卡券时需要传入card_id
    
    返回:
    
    调用返回的JSON字符串。
    可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
    
    抛出:
    
    WxErrorException
  - markCardCode
```
void markCardCode(String code,
                  String cardId,
                  String openId,
                  boolean isMark)
           throws WxErrorException
```
    卡券Mark接口。开发者在帮助消费者核销卡券之前，必须帮助先将此code（卡券串码）与一个openid绑定（即mark住），才能进一步调用核销接口，否则报错。
    
    参数:
    
    code - 卡券的code码
    
    cardId - 卡券的ID
    
    openId - 用券用户的openid
    
    isMark - 是否要mark（占用）这个code，填写true或者false，表示占用或解除占用
    
    抛出:
    
    WxErrorException
  - getCardDetail
```
String getCardDetail(String cardId)
              throws WxErrorException
```
    查看卡券详情接口详见 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
    
    参数:
    
    cardId - 卡券的ID
    
    返回:
    
    返回的卡券详情JSON字符串
    [注] 由于返回的JSON格式过于复杂，难以定义其对应格式的Bean并且难以维护，因此只返回String格式的JSON串。
    可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段。
    
    抛出:
    
    WxErrorException
  - addTestWhiteList
```
String addTestWhiteList(String openid)
                 throws WxErrorException
```
    添加测试白名单
    
    参数:
    
    openid - 用户的openid
    
    返回:
    
    抛出:
    
    WxErrorException
  - createCard
```
WxMpCardCreateResult createCard(WxMpCardCreateMessage cardCreateMessage)
                         throws WxErrorException
```
    参数:
    
    cardCreateMessage -
    
    返回:
    
    抛出:
    
    WxErrorException
  - createQrcodeCard
```
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                            String outerStr)
                                     throws WxErrorException
```
    创建卡券二维码
    
    参数:
    
    cardId - 卡券编号
    
    outerStr - 二维码标识
    
    返回:
    
    WxMpCardQrcodeCreateResult
    
    抛出:
    
    WxErrorException
  - createQrcodeCard
```
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId,
                                            String outerStr,
                                            int expiresIn)
                                     throws WxErrorException
```
    创建卡券二维码
    
    参数:
    
    cardId - 卡券编号
    
    outerStr - 二维码标识
    
    expiresIn - 失效时间，单位秒，不填默认365天
    
    返回:
    
    WxMpCardQrcodeCreateResult
    
    抛出:
    
    WxErrorException
  - createLandingPage
```
WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest createRequest)
                                           throws WxErrorException
```
    创建卡券货架
    
    参数:
    
    createRequest - 货架创建参数
    
    返回:
    
    抛出:
    
    WxErrorException
  - unavailableCardCode
```
String unavailableCardCode(String cardId,
                           String code,
                           String reason)
                    throws WxErrorException
```
    将用户的卡券设置为失效状态详见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025272&anchor=9
    
    参数:
    
    cardId - 卡券编号
    
    code - 用户会员卡号
    
    reason - 设置为失效的原因
    
    返回:
    
    抛出:
    
    WxErrorException
  - deleteCard
```
WxMpCardDeleteResult deleteCard(String cardId)
                         throws WxErrorException
```
    删除卡券接口
    
    参数:
    
    cardId -
    
    返回:
    
    抛出:
    
    WxErrorException

接口 WxMpCardService

字段概要

方法概要

字段详细资料

CARD_CREATE

CARD_GET

CARD_GET_TICKET

CARD_CODE_DECRYPT

CARD_CODE_GET

CARD_CODE_CONSUME

CARD_CODE_MARK

CARD_TEST_WHITELIST

CARD_QRCODE_CREATE

CARD_LANDING_PAGE_CREATE

CARD_CODE_UNAVAILABLE

CARD_DELETE

方法详细资料

getWxMpService

getCardApiTicket

getCardApiTicket

createCardApiSignature

decryptCardCode

queryCardCode

consumeCardCode

consumeCardCode

markCardCode

getCardDetail

addTestWhiteList

createCard

createQrcodeCard

createQrcodeCard

createLandingPage

unavailableCardCode

deleteCard