Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.foxinmy.weixin4j.mp.api
Class CardApi

java.lang.Object
  extended by com.foxinmy.weixin4j.api.BaseApi
      extended by com.foxinmy.weixin4j.mp.api.MpApi
          extended by com.foxinmy.weixin4j.mp.api.CardApi

public class CardApi
extends MpApi

卡券API

Since:
JDK 1.6
Author:
jinyu(foxinmy@gmail.com)
See Also:
卡券说明

Constructor Summary
CardApi(TokenManager tokenManager)
           
 
Method Summary
 ApiResult activateMemberCard(MemberInitInfo memberInitInfo)
          激活方式说明 接口激活通常需要开发者开发用户填写资料的网页。通常有两种激活流程： 1.
 String createCardCoupon(CardCoupon cardCoupon)
          创建卡券:创建卡券接口是微信卡券的基础接口，用于创建一类新的卡券，获取card_id，创建成功并通过审核后， 商家可以通过文档提供的其他接口将卡券下发给用户，每次成功领取，库存数量相应扣除。 1.需自定义Code码的商家必须在创建卡券时候，设定use_custom_code为true，且在调用投放卡券接口时填入指定的Code码。 指定OpenID同理。特别注意：在公众平台创建的卡券均为非自定义Code类型。 2.can_share字段指领取卡券原生页面是否可分享，建议指定Code码、指定OpenID等强限制条件的卡券填写false。 3.创建成功后该卡券会自动提交审核 ，审核结果将通过事件通知商户。开发者可调用设置白名单接口设置用户白名单，领取未通过审核的卡券，测试整个卡券的使用流程。
 QRResult createCardQR(Integer expireSeconds, CardQR... cardQRs)
          创建卡券二维码： 开发者可调用该接口生成一张卡券二维码供用户扫码后添加卡券到卡包。
 MemberUserInfo getMemberUserInfo(String cardId, String code)
          拉取会员信息接口。
 CardStatus queryCardStatus(String cardId)
          查看获取卡券的审核状态
 ApiResult setActivateUserForm(MemberUserForm memberUserForm)
          设置开卡字段接口 开发者在创建时填入wx_activate字段后， 需要调用该接口设置用户激活时需要填写的选项，否则一键开卡设置不生效。
 ApiResult setCardPayCell(String cardId, boolean isOpen)
          设置卡券买单：创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持微信买单功能。值得开发者注意的是， 设置买单的card_id必须已经配置了门店，否则会报错。
 ApiResult setCardSelfConsumeCell(String cardId, boolean isOpen)
          设置自助核销:创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持自助核销功能。值得开发者注意的是， 设置自助核销的card_id必须已经配置了门店，否则会报错。
 ApiResult setTestWhiteList(List<String> openIds, List<String> userNames)
          由于卡券有审核要求，为方便公众号调试，可以设置一些测试帐号，这些帐号可领取未通过审核的卡券，体验整个流程。 1.同时支持“openid”、“username”两种字段设置白名单，总数上限为10个。 2.设置测试白名单接口为全量设置，即测试名单发生变化时需调用该接口重新传入所有测试人员的ID.
 Boolean updateCardCoupon(String cardId, CardCoupon card)
          支持更新所有卡券类型的部分通用字段及特殊卡券（会员卡、飞机票、电影票、会议门票）中特定字段的信息。
 com.alibaba.fastjson.JSONObject updateMemberUserInfo(MemberUpdateInfo updateInfo)
          更新会员 result_bonus 当前用户积分总额 result_balance 当前用户预存总金额 openid 用户openid
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CardApi

public CardApi(TokenManager tokenManager)
Method Detail

createCardCoupon

public String createCardCoupon(CardCoupon cardCoupon)
                        throws WeixinException
创建卡券:创建卡券接口是微信卡券的基础接口，用于创建一类新的卡券，获取card_id，创建成功并通过审核后， 商家可以通过文档提供的其他接口将卡券下发给用户，每次成功领取，库存数量相应扣除。
  • 1.需自定义Code码的商家必须在创建卡券时候，设定use_custom_code为true，且在调用投放卡券接口时填入指定的Code码。 指定OpenID同理。特别注意：在公众平台创建的卡券均为非自定义Code类型。
  • 2.can_share字段指领取卡券原生页面是否可分享，建议指定Code码、指定OpenID等强限制条件的卡券填写false。
  • 3.创建成功后该卡券会自动提交审核 ，审核结果将通过事件通知商户。开发者可调用设置白名单接口设置用户白名单，领取未通过审核的卡券，测试整个卡券的使用流程。

    Parameters:
    cardCoupon - 卡券对象
    Returns:
    卡券ID
    Throws:
    WeixinException
    See Also:
    创建卡券, CardCoupons, MediaApi.uploadImage(java.io.InputStream, String)

    • setCardPayCell

    public ApiResult setCardPayCell(String cardId,
                                boolean isOpen)
                         throws WeixinException
    设置卡券买单：创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持微信买单功能。值得开发者注意的是， 设置买单的card_id必须已经配置了门店，否则会报错。

    Parameters:
    cardId - 卡券ID
    isOpen - 是否开启买单功能，填true/false
    Returns:
    操作结果
    Throws:
    WeixinException
    See Also:
    createCardCoupon(CardCoupon)

    setCardSelfConsumeCell

    public ApiResult setCardSelfConsumeCell(String cardId,
                                        boolean isOpen)
                                 throws WeixinException
    设置自助核销:创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持自助核销功能。值得开发者注意的是， 设置自助核销的card_id必须已经配置了门店，否则会报错。

    Parameters:
    cardId - 卡券ID
    isOpen - 是否开启买单功能，填true/false
    Returns:
    操作结果
    Throws:
    WeixinException
    See Also:
    createCardCoupon(CardCoupon)

    createCardQR

    public QRResult createCardQR(Integer expireSeconds,
                             CardQR... cardQRs)
                      throws WeixinException
    创建卡券二维码： 开发者可调用该接口生成一张卡券二维码供用户扫码后添加卡券到卡包。

    Parameters:
    expireSeconds - 指定二维码的有效时间，范围是60 ~ 1800秒。不填默认为365天有效
    cardQRs - 二维码参数:二维码领取单张卡券/多张卡券
    Returns:
    二维码结果对象
    Throws:
    WeixinException
    See Also:
    QRResult, QRParameter, 投放卡券

    setTestWhiteList

    public ApiResult setTestWhiteList(List<String> openIds,
                                  List<String> userNames)
                           throws WeixinException
    由于卡券有审核要求，为方便公众号调试，可以设置一些测试帐号，这些帐号可领取未通过审核的卡券，体验整个流程。 1.同时支持“openid”、“username”两种字段设置白名单，总数上限为10个。 2.设置测试白名单接口为全量设置，即测试名单发生变化时需调用该接口重新传入所有测试人员的ID. 3.白名单用户领取该卡券时将无视卡券失效状态，请开发者注意。

    Parameters:
    openIds - the open ids
    userNames - the user names
    Throws:
    WeixinException
    Since:
    2016 -12-20 11:22:57
    See Also:
    设置测试白名单

    queryCardStatus

    public CardStatus queryCardStatus(String cardId)
                           throws WeixinException
    查看获取卡券的审核状态

    Throws:
    WeixinException
    Since:
    2016 -12-20 11:48:23
    See Also:
    查看卡券详情

    updateCardCoupon

    public Boolean updateCardCoupon(String cardId,
                                CardCoupon card)
                         throws WeixinException
    支持更新所有卡券类型的部分通用字段及特殊卡券（会员卡、飞机票、电影票、会议门票）中特定字段的信息。

    Parameters:
    cardId - the card id
    card - the card
    Returns:
    是否提交审核，false为修改后不会重新提审，true为修改字段后重新提审，该卡券的状态变为审核中
    Throws:
    WeixinException - the weixin exception
    Since:
    2016 -12-21 15:29:10
    See Also:

    activateMemberCard

    public ApiResult activateMemberCard(MemberInitInfo memberInitInfo)
                             throws WeixinException
    激活方式说明 接口激活通常需要开发者开发用户填写资料的网页。通常有两种激活流程： 1. 用户必须在填写资料后才能领卡，领卡后开发者调用激活接口为用户激活会员卡； 2. 是用户可以先领取会员卡，点击激活会员卡跳转至开发者设置的资料填写页面，填写完成后开发者调用激活接口为用户激活会员卡。

    Throws:
    WeixinException
    See Also:
    接口激活

    setActivateUserForm

    public ApiResult setActivateUserForm(MemberUserForm memberUserForm)
                              throws WeixinException
    设置开卡字段接口 开发者在创建时填入wx_activate字段后， 需要调用该接口设置用户激活时需要填写的选项，否则一键开卡设置不生效。

    Throws:
    WeixinException
    See Also:
    一键激活

    getMemberUserInfo

    public MemberUserInfo getMemberUserInfo(String cardId,
                                        String code)
                                 throws WeixinException
    拉取会员信息接口。

    Parameters:
    cardId - the card id
    code - the code
    Throws:
    WeixinException
    Since:
    2016 -12-21 11:28:45

    updateMemberUserInfo

    public com.alibaba.fastjson.JSONObject updateMemberUserInfo(MemberUpdateInfo updateInfo)
                                                     throws WeixinException
    更新会员 result_bonus 当前用户积分总额 result_balance 当前用户预存总金额 openid 用户openid

    Parameters:
    updateInfo -
    Returns:
    Throws:
    WeixinException
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    Copyright © 2014–2017. All rights reserved.