## **接口内容列表**
[TOC]
## **创建微信卡券**
参数`$data`为卡券数据（请参考微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 创建微信卡券
$result = $card->createCard($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **更新微信卡券信息**
参数`$data`为卡券数据（请参考微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 更新微信卡券信息
$result = $card->updateCard($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **删除微信卡券**
* 参数`$cardid`为生成卡券的`cord_id`
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 删除微信卡券
$result = $card->delCard($cardid);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取粉丝下所有卡券列表**
* 参数`$openid`指定获取粉丝的Openid
* 参数`$cardid`指定生成卡券的`cord_id`（ 可选）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 获取粉丝微信卡券列表
$result = $card->getCardList($openid, $card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取微信卡券用于图文的HTML代码**
* 参数`$cardid`为生成卡券的`cord_id`
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 获取卡卷用于图文的HTML代码
$result = $card->getCardMpHtml($cardid);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **微信卡券`code`核查**
* 参数`$cardid`为生成卡卷的`cord_id`
* 参数`$code_list`为需要核查的`code`列表
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 微信卡卷code核查
$result = $card->checkCardCodeList($card_id,$code_list);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **查询微信卡券详情**
* 参数`$card_id`为生成卡卷的`cord_id`
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 查询微信卡券详情
$result = $card->getCardInfo($card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
**获取微信卡券颜色列表**
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 获取微信卡券颜色列表
$result = $card->getCardColors();
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
**拉取微信门店列表**
* 参数`offset`为开始拉取的偏移，默认为0从头开始
* 参数`$count`为拉取的数量，默认为0拉取全部，不大于50
~~~
// 创建SDK实例
$card = & load_wechat('Poi');
// 拉取微信门店列表
$result = $card->getPoiList($offset, $count);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **批量导入微信门店信息**
* 参数`$data`为门店数据（请参数微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Poi);
// 批量导入微信门店信息
$result = $card->addPoi($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $result->errMsg;
}else{
// 接口成功的处理
}
~~~
## **生成微信卡券二维码**
* 参数`$card_id`为生成卡卷的`cord_id`
* 参数`$code`指定卡券 code 码，只能被领一次。use\_custom\_code 字段为 true 的卡券必须填写，非自定义 code 不必填写。
* 参数`$openid`指定领取者的 openid，只有该用户能领取。bind\_openid 字段为 true 的卡券必须填写，非自定义 openid 不必填写。
* 参数`$expire_seconds`指定二维码的有效时间，范围是 60 ~ 1800 秒。不填默认为永久有效。
* 参数`$is_unique_code`指定下发二维码，生成的二维码随机分配一个 code，领取后不可再次扫描。填写 true 或 false。默认 false。
* 参数`$balance`红包余额，以分为单位。红包类型必填（LUCKY\_MONEY），其他卡券类型不填。
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 生成微信卡券二维码
$result = $card->createCardQrcode($card_id, $code, $openid, $expire_seconds, $is_unique_code, $balance);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **核销微信卡券`code`**
* 参数`$code`指定核销卡券`code`值
* 参数`$card_id`为要消耗序列号所述的 card\_id（创建卡券时use\_custom\_code 填写 true 时必填）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 核销微信卡券code
$result = $card->consumeCardCode($code, $card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **JS选取卡券的加密`code`解密**
* 参数`$encrypt_code`为通过`jssdk`的`choose_card_info`获取的加密字符串
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// JS选取卡券的加密code解密
$result = $card->decryptCardCode($encrypt_code);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **查询微信`code`的有效性（非自定义 code）**
* 参数`$code`为需要查询的卡券`code`值
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 查询微信code的有效性
$result = $card->checkCardCode($code);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **批量查询微信卡券列表**
* 参数`$offset`为开始拉取的偏移，默认为0从头开始
* 参数`$count`为需要查询的卡片的数量（数量最大50,默认50）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 批量查询微信卡券列表
$result = $card->getCardIdList($offset, $count);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **更改微信卡券`code`编码**
* 参数`$code`为卡券的`code`编码
* 参数`$card_id`为卡券 ID
* 参数`$new_code`新的卡券`code`编码
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 批量查询微信卡券列表
$result = $card->updateCardCode($code, $card_id, $new_code);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **设置微信卡券失效**
* 参数`$code`为卡券的`code`编码
* 参数`$card_id`为卡券 ID
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 设置微信卡券失效
$result = $card->unavailableCardCode($code, $card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **修改微信卡券的库存**
* 参数`$data`为卡券数据（请参考微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 修改微信卡券的库存
$result = $card->modifyCardStock($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **修改微信卡券的库存**
* 参数`$data`为卡券数据（请参考微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 修改微信卡券的库存
$result = $card->modifyCardStock($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **设置自助核销接口**
* 参数`$data`为卡券门票数据（请参考微信官方文档）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 设置自助核销接口
$result = $card->setSelfconsumecell($card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **激活/绑定微信会员卡**
* 参数`$data`为微信会员卡数据，具体结构请参看卡券开发文档(6.1.1 激活/绑定会员卡)章节
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 激活/绑定微信会员卡
$result = $card->activateMemberCard($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **微信会员卡交易**
* 参数`$data`为交易数据，具体结构请参看卡券开发文档(6.1.2 会员卡交易)章节
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 微信会员卡交易
$result = $card->updateMemberCard($data);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **设置微信卡券测试白名单**
* 参数`$openid`测试的`openid`列表（一维数组）
* 参数`$user`测试的微信号列表（一维数组）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 设置微信卡券测试白名单
$result = $card->setCardTestWhiteList($openid, $user);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **更新微信卡券红包金额**
* 参数`$code`为红包的序列号
* 参数`$balance`为红包余额
* 参数`$card_id`自定义 code 的卡券必填（非自定义 code 可不填）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 更新微信卡券红包金额
$result = $card->updateLuckyMoney($code, $balance, $card_id);
// 处理执行结果
if($result===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
~~~
## **微信H5查询卡卷列表**
## 服务端PHP业务代码
* 参数`$cardid`为生成卡卷的`cord_id`（可选）
* 参数`$cardtype`指定卡卷的类型代码（可选）
* 参数`$shop`指定卡卷可用的门店ID（可选）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 通过SDK创建查询H5查询JS签名包
$option = $card ->createChooseCardJsPackage($cardid,$cardtype,$shopid);
// 处理创建结果
if($option===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
// 将签名包进行JSON处理
$card_sign = json_encode($option, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
~~~
## 客户端JS业务代码
~~~
wx.ready(function () {
// 接收PHP生成的H5查询JS签名包参数
var option = $card_sign;
option.success = function (res) {
// 成功之后返回结果
alert(JSON.stringify(res));
};
// 执行H5事件
wx.chooseCard(option);
});
~~~
## **微信H5领取卡卷**
## 服务端PHP业务代码
* 参数`$cardid`为生成卡卷的`cord_id`（可选）
* 参数`$data`为其它限定参数，关联一维数据（可选）
~~~
// 创建SDK实例
$card = & load_wechat('Card');
// 通过SDK创建取H5查询JS签名包
$option = $card ->createAddCardJsPackage($cardid,$data);
// 处理创建结果
if($option===FALSE){
// 接口失败的处理
echo $card->errMsg;
}else{
// 接口成功的处理
}
// 将签名包进行JSON处理
$card_sign = json_encode($option, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
~~~
## 客户端JS业务代码
~~~
wx.ready(function () {
// 接收PHP生成的H5查询JS签名包参数
var option = $card_sign;
option.success = function (res) {
// 成功之后返回结果
alert(JSON.stringify(res));
};
// 执行H5事件
wx.addCard(option);
});
~~~
