天天看點

支付寶卡包——管理卡劵(alipay.pass.template.update)一、注意事項二、參數說明三、接口請求示例

接口名稱:支付寶pass更新模版接口

英文名稱:alipay.pass.template.update

上一步:[url]https://openclub.alipay.com/read.php?tid=13243&fid=72[/url]

一、注意事項

該接口主要用于管理卡劵模闆樣式進行修改、。

二、參數說明

參數說明詳見alipay.pass.template.add(卡券模闆建立)接口示例。

1、tpl_id:需修改模闆ID,建立卡劵模闆接口傳回;

2、tpl_content:content(即pass.json内容,必傳)、icon、logo(圖檔url位址,必傳)、strip(圖檔的url位址);

3、content:模闆中的自定義參數以雙$符号标志,即$ serialNumber $表示自定義參數名為serialNumber,供釋出卡券時使用

三、接口請求示例

Java版本請求示例

public static void main(String[] args) throws AlipayApiException {
     AlipayClient alipayClient = new DefaultAlipayClient(AlipayConfig.gatewayUrl, AlipayConfig.app_id, AlipayConfig.merchant_private_key, AlipayConfig.format, AlipayConfig.charset, AlipayConfig.alipay_public_key, AlipayConfig.sign_type); 
     AlipayPassTemplateUpdateRequest request = new AlipayPassTemplateUpdateRequest();
     request.setBizContent(
           "{\"tpl_id\":\"2019013016274826850929194\","
           + "\"tpl_content\":"
           + "{\"logo\":\"https://alipass.alipay.com//temps/free/logo.png\","
           + "\"strip\":\"https://alipass.alipay.com//temps/free/strip.png\","
           +"\"icon\":\"http://alipassprod.test.alipay.net/temps/free/icon.png\","
           + "\"content\":"
           + "{\"evoucherInfo\":"
           + "{\"title\":\"九月一号更新卡券模闆優惠券\",\"type\":\"coupon\",\"product\":\"free\",\"startDate\":\"$validStartDate$\",\"endDate\":\"$validEndDate$\",\"operation\":"
           + "[{\"format\":\"barcode\",\"message\":\"45612346579465\",\"messageEncoding\":\"UTF-8\",\"altText\":\"45612346579465\"}],"
           + "\"einfo\":{"
           + "\"logoText\":\"$logoText$\","
           + "\"secondLogoText\":\"$secondLogoText$\","
           + "\"headFields\":"
           + "[{\"key\":\"status\",\"label\":\"狀态\",\"value\":\"$useStateDesc$\",\"type\":\"text\"}],"
           + "\"primaryFields\":"
           + "[{\"key\":\"strip\",\"label\":\"\",\"value\":\"$discountInfo$\",\"type\":\"text\"}],"
           + "\"secondaryFields\":"
           + "[{\"key\":\"validDate\",\"label\":\"有效期至:\",\"value\":\"$validEndDate$\",\"type\":\"text\"}],"
           + "\"auxiliaryFields\":[],"
           + "\"backFields\":"
           + "[{\"key\":\"description\",\"label\":\"詳情描述\",\"value\":\"1.該優惠有效期:截止至2024年06月18日;\
2.憑此券可以享受以下優惠:\
享門市價優惠\
不與其他優惠同享。詳詢商家。\",\"type\":\"text\"},"
           + "{\"key\":\"shops\",\"label\":\"可用門店\",\"value\":\"\",\"type\":\"text\"},"
           + "{\"key\":\"disclaimer\",\"label\":\"負責聲明\",\"value\":\"除特殊注明外,本優惠不能與其他優惠同時享受;本優惠最終解釋權歸商家所有,如有疑問請與商家聯系。提示:為了使您得到更好的服務,請在進店時出示本券。\",\"type\":\"text\"}"
           + "]},"
           + "\"remindInfo\":"
           + "{\"offset\":\"2\"}},"
           + "\"merchant\":{\"mname\":\"hodewu\",\"mtel\":\"\",\"minfo\":\"\"},"
           + "\"platform\":{\"channelID\":\"$channelID$\",\"webServiceUrl\":\"\"},"
           + "\"style\":{\"backgroundColor\":\"RGB(255,126,0)\"},"
           + "\"fileInfo\":{\"formatVersion\":\"2\",\"canShare\":true,\"canBuy\":false,\"canPresent\":true,\"serialNumber\":\"$serialNumber$\",\"supportTaxi\":\"true\",\"taxiSchemaUrl\":\"alipays://platformapi/startapp?appId=20000130&sourceId=20000030&showTitleBar=YES&showToolBar=NO&showLoading=NO&safePayEnabled=YES&readTitle=YES&backBehavior=back&url=/www/index.html\"},"
           + "\"appInfo\":{\"app\":{},\"label\":\"\",\"message\":\"\"},"
           + "\"source\":\"alipassprod\","
           + "\"alipayVerify\":[]"
           + "}}}");
          AlipayPassTemplateUpdateResponse response=null;
          try {
              response = alipayClient.execute(request);
              System.out.println(response.getBody());
          } catch (AlipayApiException e) {
              // TODO Auto-generated catch block
              e.printStackTrace();
          }
          if(response.isSuccess()){
          System.out.println("調用成功");
          } else {
          System.out.println("調用失敗");
          }
}      

響應參數傳回示例

{"alipay_pass_template_update_response":{"code":"10000","msg":"Success","result":"{"errorCode":"KP.AE_SUCCESS","errorMsg":"處理成功","tpl_id":"2019013016274826850929194","tpl_params":["useStateDesc","logoText","discountInfo","secondLogoText","validEndDate","validStartDate","serialNumber","channelID"]}","success":true},"sign":"ETPaWh0xRBEMuPG7TeW3mOUkqXV19JE3taIpPGT4zXjmsuI9c6HKaM95amxLCA/f+vjk3VGrkv2c4Oa5EJkn0ur22f1sR9Vj5d0XGG7gakmf4fsZ9cu+gTxUeg/md2GUAL6E3KVjOkiylsjs2WHM/i6FbHdYWNhSWtgc/ebkuK2GuOBC3LosFuhVOgcuG6xnhAh2Qi+lqcLVv4OZEDEJz9nkwUXwoBni60WZIaSmfecKIhV5/JAuy89dqcYsif1CgYA9VEu6aiqPd1G0GHnPxQwOivCyG3X2lIHHNt/+yKrFn70PS/sFWNIjqQP801okBgKzc/Zymd7n9kBS0kCVzA=="}
      

PHP版本請求示例

<?php
require_once 'AopSdk.php';
$aop = new AopClient ();
$aop->appId = '填寫您的appid';
$aop->rsaPrivateKey = '填寫您的私鑰';
$aop->alipayrsaPublicKey='填寫您的支付寶公鑰';
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='utf-8';
$aop->format='json';
$date=date("YmdHis");
$arr=range(1000,9999);
shuffle($arr);
$request = new AlipayPassTemplateUpdateRequest ();
$request->setBizContent(
              '{"tpl_id":"2019022209351735229484926",'
           .  '"tpl_content":{'
      	   .  '"logo":"https://alipass.alipay.com//temps/free/logo.png",'
      	   .  '"strip":"https://alipass.alipay.com//temps/free/strip.png",'
      	   .  '"icon":"http://alipassprod.test.alipay.net/temps/free/icon.png",'
       	   .  '"content":{'
       	   .  '"evoucherInfo":{'
           .  '"title":"九月一号更新卡券模闆優惠券","type":"coupon","product":"free","startDate":"$validStartDate$","endDate":"$validEndDate$",'
		   .  '"operation":'
           .  '[{"format":"barcode","message":"45612346579465","messageEncoding":"UTF-8","altText":"45612346579465"}],'
           .  '"einfo":{'
           .  '"logoText":"$logoText$",'
           .  '"secondLogoText":"$secondLogoText$",'
           .  '"headFields":'
           .  '[{"key":"status","label":"狀态","value":"$useStateDesc$","type":"text"}],'
           .  '"primaryFields":'
           .  '[{"key":"strip","label":"","value":"$discountInfo$","type":"text"}],'
           .  '"secondaryFields":'
           .  '[{"key":"validDate","label":"有效期至:","value":"$validEndDate$","type":"text"}],'
           .  '"auxiliaryFields":[],'
           .  '"backFields":'
           .  '[{"key":"description","label":"詳情描述","value":"1.該優惠有效期:截止至2024年06月18日;n2.憑此券可以享受以下優惠:n享門市價優惠n不與其他優惠同享。詳詢商家。","type":"text"},'
           .  '{"key":"shops","label":"可用門店","value":"","type":"text"},'
           .  '{"key":"disclaimer","label":"負責聲明","value":"除特殊注明外,本優惠不能與其他優惠同時享受;本優惠最終解釋權歸商家所有,如有疑問請與商家聯系。提示:為了使您得到更好的服務,請在進店時出示本券。","type":"text"}'
           .  ']},'
           .  '"remindInfo":'
           .  '{"offset":"2"}},'
           .  '"merchant":{"mname":"hodewu","mtel":"","minfo":""},'
           .  '"platform":{"channelID":"$channelID$","webServiceUrl":""},'
           .  '"style":{"backgroundColor":"RGB(255,126,0)"},'
           .  '"fileInfo":{"formatVersion":"2","canShare":true,"canBuy":false,"canPresent":true,"serialNumber":"$serialNumber$","supportTaxi":"true","taxiSchemaUrl":"alipays://platformapi/startapp?appId=20000130&sourceId=20000030&showTitleBar=YES&showToolBar=NO&showLoading=NO&safePayEnabled=YES&readTitle=YES&backBehavior=back&url=/www/index.html"},'
           .  '"appInfo":{"app":{},"label":"","message":""},'
           .  '"source":"alipassprod",'
           .  '"alipayVerify":[]'
           .  '}}}');
$result = $aop->execute ( $request); 
var_dump($result);
$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失敗";
}      
public 'alipay_pass_template_update_response' => 
    object(stdClass)[9]
      public 'code' => string '10000' (length=5)
      public 'msg' => string 'Success' (length=7)
      public 'result' => string '{"errorCode":"KP.AE_SUCCESS","errorMsg":"處理成功","tpl_id":"2019022209351735229484926","tpl_params":["useStateDesc","logoText","discountInfo","secondLogoText","validEndDate","validStartDate","serialNumber","channelID"]}' (length=224)
      public 'success' => boolean true
  public 'sign' => string 'fCqydQLMdftRqn7qg4KzFQi5VFNtf+uNTrBQoFTUQVd39KJygYcCBCHdpnmaSvvg2Cc1xl7ybfjTGd+Kc4szXDIutE4fCY9+ws2MwDcHEGEBzyi7nL3LmtzArTCZGe/CxckCrP1Ye/nUI/Hp+6jDbR7Bn2bx7/tJcGjnjGe3Ja5RcQnM8MjiLMrF6Tet63WP3TXee8Zi8VH38HNbqFms44gl8xxa9tJhNr+HFz1QFBM0lI4Mi/3FwSOIYNNMPEXiwPgPyMlR2vpdQjMHhbNuA3z4EXKwIjJbk9JuSraF2Kc6O664IJqznQEmRJwZtP138JwJ02kihhxuKWC4G51ElQ==' (length=344)      

.NET版本請求示例

IAopClient client = new DefaultAopClient(config.gatewayUrl, config.app_id, config.private_key, "json", "1.0", "RSA2", config.alipay_public_key, config.charset, false);

        AlipayPassTemplateUpdateRequest request = new AlipayPassTemplateUpdateRequest();

        request.BizContent="{"
                    + ""tpl_id":"2019040215104450132405465","
                    + ""tpl_content":"
                    + "{"logo":"https://alipass.alipay.com//temps/free/logo.png","
                    + ""strip":"https://alipass.alipay.com//temps/free/strip.png","
                    + ""icon":"http://alipassprod.test.alipay.net/temps/free/icon.png","
                    + ""content":{"