#1055 增加创建卡券二维码接口缺失的一些参数

This commit is contained in:
Binary Wang 2019-06-09 19:51:02 +08:00
parent 6dc9d378c5
commit 2422a28f9a
3 changed files with 92 additions and 28 deletions

View File

@ -13,6 +13,8 @@ import me.chanjar.weixin.mp.bean.card.*;
public interface WxMpCardService {
/**
* 得到WxMpService.
*
* @return WxMpService
*/
WxMpService getWxMpService();
@ -20,6 +22,7 @@ public interface WxMpCardService {
* 获得卡券api_ticket不强制刷新卡券api_ticket.
*
* @return 卡券api_ticket
* @throws WxErrorException 异常
* @see #getCardApiTicket(boolean)
*/
String getCardApiTicket() throws WxErrorException;
@ -34,7 +37,7 @@ public interface WxMpCardService {
*
* @param forceRefresh 强制刷新
* @return 卡券api_ticket
* @throws WxErrorException
* @throws WxErrorException 异常
*/
String getCardApiTicket(boolean forceRefresh) throws WxErrorException;
@ -47,18 +50,19 @@ public interface WxMpCardService {
* .9F.E6.88.90.E7.AE.97.E6.B3.95
* </pre>
*
* @param optionalSignParam 参与签名的参数数组
* 可以为下列字段app_id, card_id, card_type, code, openid, location_id
* @param optionalSignParam 参与签名的参数数组可以为下列字段app_id, card_id, card_type, code, openid, location_id
* </br>注意当做wx.chooseCard调用时必须传入app_id参与签名否则会造成签名失败导致拉取卡券列表为空
* @return 卡券Api签名对象
* @throws WxErrorException 异常
*/
WxCardApiSignature createCardApiSignature(String... optionalSignParam) throws WxErrorException;
WxCardApiSignature createCardApiSignature(String... optionalSignParam) throws WxErrorException;
/**
* 卡券Code解码.
*
* @param encryptCode 加密Code通过JSSDK的chooseCard接口获得
* @return 解密后的Code
* @throws WxErrorException 异常
*/
String decryptCardCode(String encryptCode) throws WxErrorException;
@ -70,16 +74,16 @@ public interface WxMpCardService {
* @param code 单张卡券的唯一标准
* @param checkConsume 是否校验code核销状态填入true和false时的code异常状态返回数据不同
* @return WxMpCardResult对象
* @throws WxErrorException 异常
*/
WxMpCardResult queryCardCode(String cardId, String code, boolean checkConsume)
throws WxErrorException;
WxMpCardResult queryCardCode(String cardId, String code, boolean checkConsume) throws WxErrorException;
/**
* 卡券Code核销核销失败会抛出异常
*
* @param code 单张卡券的唯一标准
* @return 调用返回的JSON字符串
* <br>可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息
* @return 调用返回的JSON字符串可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息
* @throws WxErrorException 异常
*/
String consumeCardCode(String code) throws WxErrorException;
@ -88,13 +92,13 @@ public interface WxMpCardService {
*
* @param code 单张卡券的唯一标准
* @param cardId 当自定义Code卡券时需要传入card_id
* @return 调用返回的JSON字符串
* <br>可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息
* @return 调用返回的JSON字符串可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息
* @throws WxErrorException 异常
*/
String consumeCardCode(String code, String cardId) throws WxErrorException;
/**
* 卡券Mark接口
* 卡券Mark接口.
* 开发者在帮助消费者核销卡券之前必须帮助先将此code卡券串码与一个openid绑定即mark住
* 才能进一步调用核销接口否则报错
*
@ -102,6 +106,7 @@ public interface WxMpCardService {
* @param cardId 卡券的ID
* @param openId 用券用户的openid
* @param isMark 是否要mark占用这个code填写true或者false表示占用或解除占用
* @throws WxErrorException 异常
*/
void markCardCode(String code, String cardId, String openId, boolean isMark) throws WxErrorException;
@ -113,6 +118,7 @@ public interface WxMpCardService {
* @return 返回的卡券详情JSON字符串
* <br> [] 由于返回的JSON格式过于复杂难以定义其对应格式的Bean并且难以维护因此只返回String格式的JSON串
* <br> 可由 com.google.gson.JsonParser#parse 等方法直接取JSON串中的某个字段
* @throws WxErrorException 异常
*/
String getCardDetail(String cardId) throws WxErrorException;
@ -120,14 +126,17 @@ public interface WxMpCardService {
* 添加测试白名单.
*
* @param openid 用户的openid
* @return
* @return string
* @throws WxErrorException 异常
*/
String addTestWhiteList(String openid) throws WxErrorException;
/**
* @param cardCreateMessage
* @return
* @throws WxErrorException
* 创建卡券.
*
* @param cardCreateMessage 请求
* @return result
* @throws WxErrorException 异常
*/
WxMpCardCreateResult createCard(WxMpCardCreateMessage cardCreateMessage) throws WxErrorException;
@ -137,6 +146,7 @@ public interface WxMpCardService {
* @param cardId 卡券编号
* @param outerStr 二维码标识
* @return WxMpCardQrcodeCreateResult
* @throws WxErrorException 异常
*/
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr) throws WxErrorException;
@ -145,17 +155,33 @@ public interface WxMpCardService {
*
* @param cardId 卡券编号
* @param outerStr 二维码标识
* @param expiresIn 失效时间单位秒不填默认365天
* @param expiresIn 指定二维码的有效时间范围是60 ~ 1800秒不填默认为365天有效
* @return WxMpCardQrcodeCreateResult
* @throws WxErrorException 异常
*/
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn) throws WxErrorException;
/**
* 创建卡券二维码.
*
* @param cardId 卡券编号
* @param outerStr 用户首次领卡时会通过 领取事件推送 给商户 对于会员卡的二维码用户每次扫码打开会员卡后点击任何url会将该值拼入url中方便开发者定位扫码来源
* @param expiresIn 指定二维码的有效时间范围是60 ~ 1800秒不填默认为365天有效
* @param isUniqueCode 指定下发二维码生成的二维码随机分配一个code领取后不可再次扫描填写true或false默认false注意填写该字段时卡券须通过审核且库存不为0
* @param code 卡券Code码,use_custom_code字段为true的卡券必须填写非自定义code和导入code模式的卡券不必填写
* @param openid 指定领取者的openid只有该用户能领取bind_openid字段为true的卡券必须填写非指定openid不必填写
* @return WxMpCardQrcodeCreateResult
* @throws WxErrorException 异常
*/
WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid,
String code, boolean isUniqueCode) throws WxErrorException;
/**
* 创建卡券货架.
*
* @param createRequest 货架创建参数
* @return
* @throws WxErrorException
* @return WxMpCardLandingPageCreateResult
* @throws WxErrorException 异常
*/
WxMpCardLandingPageCreateResult createLandingPage(WxMpCardLandingPageCreateRequest createRequest) throws WxErrorException;
@ -166,17 +192,17 @@ public interface WxMpCardService {
* @param cardId 卡券编号
* @param code 用户会员卡号
* @param reason 设置为失效的原因
* @return
* @throws WxErrorException
* @return result
* @throws WxErrorException 异常
*/
String unavailableCardCode(String cardId, String code, String reason) throws WxErrorException;
/**
* 删除卡券接口.
*
* @param cardId
* @return
* @throws WxErrorException
* @param cardId 卡券id
* @return 删除结果
* @throws WxErrorException 异常
*/
WxMpCardDeleteResult deleteCard(String cardId) throws WxErrorException;

View File

@ -185,22 +185,39 @@ public class WxMpCardServiceImpl implements WxMpCardService {
@Override
public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr) throws WxErrorException {
return createQrcodeCard(cardId, outerStr, 0);
return this.createQrcodeCard(cardId, outerStr, 0);
}
@Override
public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn) throws WxErrorException {
return this.createQrcodeCard(cardId, outerStr, expiresIn, null, null, false);
}
@Override
public WxMpCardQrcodeCreateResult createQrcodeCard(String cardId, String outerStr, int expiresIn, String openid,
String code, boolean isUniqueCode) throws WxErrorException {
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("action_name", "QR_CARD");
if (expiresIn > 0) {
jsonObject.addProperty("expire_seconds", expiresIn);
}
JsonObject actionInfoJson = new JsonObject();
JsonObject cardJson = new JsonObject();
if (openid != null) {
cardJson.addProperty("openid", openid);
}
if (code != null) {
cardJson.addProperty("code", code);
}
cardJson.addProperty("is_unique_code", isUniqueCode);
cardJson.addProperty("card_id", cardId);
cardJson.addProperty("outer_str", outerStr);
actionInfoJson.add("card", cardJson);
jsonObject.add("action_info", actionInfoJson);
return WxMpCardQrcodeCreateResult.fromJson(this.wxMpService.post(WxMpApiUrl.Card.CARD_QRCODE_CREATE, GSON.toJson(jsonObject)));
}

View File

@ -9,8 +9,7 @@ import me.chanjar.weixin.mp.bean.card.*;
import org.testng.annotations.Guice;
import org.testng.annotations.Test;
import static org.testng.AssertJUnit.assertEquals;
import static org.testng.AssertJUnit.assertNotNull;
import static org.testng.AssertJUnit.*;
/**
* 测试代码仅供参考未做严格测试因原接口作者并未提供单元测试代码
@ -106,7 +105,6 @@ public class WxMpCardServiceImplTest {
@Test
public void testCreateGrouponCard() throws WxErrorException {
BaseInfo base = new BaseInfo();
base.setLogoUrl("http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0");
base.setBrandName("测试优惠券");
@ -202,8 +200,31 @@ public class WxMpCardServiceImplTest {
public void testDeleteCard() throws Exception {
String cardId = "pwkrWjtw7W4_l50kCQcZ1in1yS6g";
WxMpCardDeleteResult result = this.wxService.getCardService().deleteCard(cardId);
assertEquals(result.isSuccess(), true);
assertTrue(result.isSuccess());
System.out.println(result);
}
@Test
public void testAddTestWhiteList() {
}
@Test
public void testCreateCard() {
}
@Test
public void testCreateQrcodeCard() {
}
@Test
public void testCreateQrcodeCard1() {
}
@Test
public void testCreateQrcodeCard2() {
}
@Test
public void testCreateLandingPage() {
}
}