me.chanjar.weixin.mp.api

接口 WxMpMemberCardService

所有已知实现类:

WxMpMemberCardServiceImpl

public interface WxMpMemberCardService

会员卡相关接口.

版本:

2017 /7/8 created on 2018-08-30

作者:

YuJian(mgcnrx11 @ gmail.com), yuanqixun

方法概要

限定符和类型	方法和说明
String	activateMemberCard(WxMpMemberCardActivatedMessage activatedMessage) 会员卡激活接口.
WxMpCardCreateResult	createMemberCard(String createJson) 会员卡创建接口.
WxMpCardCreateResult	createMemberCard(WxMpMemberCardCreateMessage createMessageMessage) 会员卡创建接口
ActivatePluginParam	getActivatePluginParam(String cardId, String outStr) 获取会员卡开卡插件参数(跳转型开卡组件需要参数).
String	getActivatePluginUrl(String cardId, String outStr) 获取开卡组件链接接口
WxMpMemberCardActivateTempInfoResult	getActivateTempInfo(String activateTicket) 解析跳转型开卡字段用户提交的资料.
WxMpMemberCardUserInfoResult	getUserInfo(String cardId, String code) 拉取会员信息接口.
WxMpService	getWxMpService() 得到WxMpService.
MemberCardActivateUserFormResult	setActivateUserForm(MemberCardActivateUserFormRequest userFormRequest) 设置会员卡激活的字段（会员卡设置：wx_activate=true 时需要）.
CardUpdateResult	updateCardInfo(MemberCardUpdateRequest memberCardUpdateRequest) 更新会员卡信息.
WxMpMemberCardUpdateResult	updateUserMemberCard(WxMpMemberCardUpdateMessage updateUserMessage) 当会员持卡消费后，支持开发者调用该接口更新会员信息.

方法详细资料

getWxMpService

WxMpService getWxMpService()

得到WxMpService.

返回:

WxMpService wx mp service

createMemberCard

WxMpCardCreateResult createMemberCard(String createJson)
                               throws WxErrorException

会员卡创建接口.

参数:

createJson - 会员卡json字符串

返回:

返回json字符串 wx mp card create result

抛出:

WxErrorException - 接口调用失败抛出的异常

createMemberCard

WxMpCardCreateResult createMemberCard(WxMpMemberCardCreateMessage createMessageMessage)
                               throws WxErrorException

会员卡创建接口

参数:

createMessageMessage - 会员卡创建对象

返回:

会员卡信息的结果对象 wx mp card create result

抛出:

WxErrorException - 接口调用失败抛出的异常

activateMemberCard

String activateMemberCard(WxMpMemberCardActivatedMessage activatedMessage)
                   throws WxErrorException

会员卡激活接口.

参数:

activatedMessage - 激活所需参数

返回:

会员卡激活后的json字符串 string

抛出:

WxErrorException - 接口调用失败抛出的异常

getUserInfo

WxMpMemberCardUserInfoResult getUserInfo(String cardId,
                                         String code)
                                  throws WxErrorException

拉取会员信息接口.

参数:

cardId - 会员卡的CardId，微信分配

code - 领取会员的会员卡Code

返回:

会员信息的结果对象 user info

抛出:

WxErrorException - 接口调用失败抛出的异常

updateUserMemberCard

WxMpMemberCardUpdateResult updateUserMemberCard(WxMpMemberCardUpdateMessage updateUserMessage)
                                         throws WxErrorException

当会员持卡消费后，支持开发者调用该接口更新会员信息. 会员卡交易后的每次信息变更需通过该接口通知微信，便于后续消息通知及其他扩展功能。 1.开发者可以同时传入add_bonus和bonus解决由于同步失败带来的幂等性问题。 同时传入add_bonus和bonus时 add_bonus作为积分变动消息中的变量值，而bonus作为卡面上的总积分额度显示。余额变动同理。 2.开发者可以传入is_notify_bonus控制特殊的积分对账变动不发送消息，余额变动同理。

参数:

updateUserMessage - 更新会员信息所需字段消息

返回:

调用返回的JSON字符串 。

抛出:

WxErrorException - 接口调用失败抛出的异常

setActivateUserForm

MemberCardActivateUserFormResult setActivateUserForm(MemberCardActivateUserFormRequest userFormRequest)
                                              throws WxErrorException

设置会员卡激活的字段（会员卡设置：wx_activate=true 时需要）.

参数:

userFormRequest - 会员卡激活字段对象

返回:

会员卡激活后结果对象 activate user form

抛出:

WxErrorException - 接口调用失败抛出的异常

getActivatePluginParam

ActivatePluginParam getActivatePluginParam(String cardId,
                                           String outStr)
                                    throws WxErrorException

获取会员卡开卡插件参数(跳转型开卡组件需要参数).

参数:

cardId - 会员卡的CardId，微信分配

outStr - 会员卡设置商户的渠道

返回:

会员卡开卡插件参数结果对象 activate plugin param

抛出:

WxErrorException - 接口调用失败抛出的异常

getActivatePluginUrl

String getActivatePluginUrl(String cardId,
                            String outStr)
                     throws WxErrorException

获取开卡组件链接接口

参数:

cardId - 会员卡的CardId，微信分配

outStr - 会员卡设置商户的渠道

返回:

会员卡开卡插件参数结果对象 activate plugin url

抛出:

WxErrorException - 接口调用失败抛出的异常

updateCardInfo

CardUpdateResult updateCardInfo(MemberCardUpdateRequest memberCardUpdateRequest)
                         throws WxErrorException

更新会员卡信息.

参数:

memberCardUpdateRequest - 会员卡更新对象

返回:

会员卡更新后结果对象 card update result

抛出:

WxErrorException - 接口调用失败抛出的异常

getActivateTempInfo

WxMpMemberCardActivateTempInfoResult getActivateTempInfo(String activateTicket)
                                                  throws WxErrorException

解析跳转型开卡字段用户提交的资料. 开发者在URL上截取ticket后须先进行urldecode

参数:

activateTicket - 用户提交的资料

返回:

开卡字段的会员信息对象 activate temp info

抛出:

WxErrorException - 接口调用失败抛出的异常