me.chanjar.weixin.mp.api

## 接口 WxMpCardService

所有已知实现类:
  WxMpCardServiceImpl

    public interface WxMpCardService

卡券相关接口

作者:
  YuJian(mgcnrx11@hotmail.com) on 01/11/2016

### 方法概要

方法
`String` `consumeCardCode(String code)` 卡券Code核销。
`String` `consumeCardCode(String code, String cardId)` 卡券Code核销。
`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
`String` `decryptCardCode(String encryptCode)` 卡券Code解码
`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
`void` `markCardCode(String code, String cardId, String openId, boolean isMark)` 卡券Mark接口。
`WxMpCardResult` `queryCardCode(String cardId, String code, boolean checkConsume)` 卡券Code查询

### 方法详细资料

#### 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查询

参数:
  `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`