## **接口內容列表**
[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);
});
~~~
