阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
param_query_card_template_open_req	QueryCardTemplateOpenReq	可选			请求对象
└ brand_id String 可选 33959 品牌id └ card_template_id String 可选 1231413 卡模板ID └ out_brand_id String 可选 33959 外部品牌id,brandId与out_brand_id不可同时为空 └ out_shop_id String 可选 4323434 外部门店id └ shop_id String 可选 22342317 门店id └ include_logical_delete Boolean 可选 true 是否包含逻辑删除 └ max_update_time Date 可选 2019-01-01 11:11:11 最后一次更新时间 └ physical_card_id String 可选 1234 物理卡号

名称	类型	示例值	描述
result	CommonResult		接口结果
└ biz_success Boolean true 成功状态 result CardTemplateOpenInfo 结果 └ card_template_id String 374749 卡模板id └ card_type String MEMBER 卡类型 └ create_by String 小李创建人 └ deleted Boolean false 逻辑删除 └ expire_type String FIX 过期类型 └ expire_value String 15 过期值 ext_info Extinfo 扩展信息 └ empty Boolean Map └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 更新时间 └ menu_id String 342342 特价菜单ID └ menu_limit_type String NO_LIMIT 特价菜限制 └ menu_switch Boolean false 特价菜单开关 └ name String 会员卡模板1 卡模板名称 └ open_gift_switch Boolean false 开卡礼包开关 └ opt_plan_id String 3435345 运营计划ID └ phy_card_fee_amount Number 20 工本费金额 └ phy_card_fee_back Boolean false 是否可退卡费 └ phy_card_fee_switch Boolean false 工本费开关 └ pre_recharge_amount Number 5 开卡礼包-赠送预储金额 └ recharge_clear Boolean false 开卡礼包-有效期结束是否清零 recharge_rule_open_info RechargeRuleOpenInfo 储值规则信息 └ card_type String 1 卡类型：0-会员卡，1-礼品卡 └ create_by String 小李创建人 └ deduction_order String 1 扣减顺序：0-比例、1-先实储后赠送、2-先增储后实储 └ deleted Boolean false 逻辑删除标记 ext_info Extinfo 扩展信息 └ empty Boolean Map └ full_gift_switch Boolean false 满赠开关：false-关，true-开，默认关闭 └ gift_type String 1 满赠类型：0-按金额（默认），1-按百分比、 └ gmt_create Date 2019-01-01 11:11:11 创建时间 └ gmt_modified Date 2019-01-01 11:11:11 修改时间 list_recharge_rule_detail_info_list RechargeRuleDetailOpenInfo [] 规则明细列表 └ gift_point Number 10 赠送积分 └ gift_value Number 20 赠送金额 └ real_value Number 100 储值金额 └ remark String 备注信息备注信息 └ pay_no_pwd_credit Number 200 免密额度:-1表示不限额，单位为分，默认200_00L └ pay_no_pwd_switch Boolean 1 免密开关:0-关闭（默认），1-开启 └ rule_id String 443234 规则id └ rule_name String 满10赠2 储值规则名称 └ shop_id String 543245 门店id └ update_by String 小李子修改人 └ out_shop_id String 234 外部门店ID └ recharge_shop_ids String [] 111,222,333 储值门店列表 └ recharge_switch Boolean true 储值开关 └ sell_price Number 20 售价 └ sell_shop_group_id String 23123 售卡门店分组ID └ sell_shop_ids String [] 111,222,333 售卡门店列表 └ startexpire_type String FIX 何时开始计算有效期 └ status String SOLD 卡模板状态 └ update_by String 小张修改人 └ use_limit_type String ACTIVED 使用限制 └ use_shop_ids String [] 111,222,333 使用门店列表 vouchers OpenGiftVoucherOpenInfo [] 开卡礼包-优惠券模板列表 └ num Number 5 数量 └ voucher_id String 123234 券模板ID wx_card_ext WxCardOpenExt 微信卡扩展 └ brand_logo String http://xxx.jpg 品牌logoURL └ general_bg_logo String http://xxx.jpg 统一卡面URL └ general_bg_switch Boolean true 是否统一卡面 └ paid_get_switch Boolean true 支付后是否可领取 wx_level_bgs WxLevelBgOpenInfo [] 等级卡面 └ bg_url String http://xxx.jpg 卡面URL └ level_id String 234234 等级ID └ level_name String 钻石卡等级名称 └ wx_card_switch Boolean true 微信卡开关 └ out_recharge_shop_ids String [] 111,222,333 外部储值门店 └ out_use_shop_ids String [] 111,222,333 外部适用门店 └ out_sell_shop_ids String [] 111,222,333 外部出售门店 └ result_code String 200 结果码 └ result_desc String 成功结果描述 └ result_view String "" 错误结果显示

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmCardQueryTemplateRequest req = new AlibabaAlscCrmCardQueryTemplateRequest();
AlibabaAlscCrmCardQueryTemplateRequest.QueryCardTemplateOpenReq obj1 = new AlibabaAlscCrmCardQueryTemplateRequest.QueryCardTemplateOpenReq();
obj1.setBrandId("33959");
obj1.setCardTemplateId("1231413");
obj1.setOutBrandId("33959");
obj1.setOutShopId("4323434");
obj1.setShopId("22342317");
obj1.setIncludeLogicalDelete(true);
obj1.setMaxUpdateTime(StringUtils.parseDateTime("2019-01-01 11:11:11"));
obj1.setPhysicalCardId("1234");
req.setParamQueryCardTemplateOpenReq(obj1);
AlibabaAlscCrmCardQueryTemplateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmCardQueryTemplateRequest req = new AlibabaAlscCrmCardQueryTemplateRequest();
AlibabaAlscCrmCardQueryTemplateRequest.QueryCardTemplateOpenReqDomain obj1 = new AlibabaAlscCrmCardQueryTemplateRequest.QueryCardTemplateOpenReqDomain();
obj1.BrandId = "33959";
obj1.CardTemplateId = "1231413";
obj1.OutBrandId = "33959";
obj1.OutShopId = "4323434";
obj1.ShopId = "22342317";
obj1.IncludeLogicalDelete = true;
obj1.MaxUpdateTime = DateTime.Parse(2019-01-01 11:11:11");
obj1.PhysicalCardId = "1234";
req.ParamQueryCardTemplateOpenReq_ = obj1;
AlibabaAlscCrmCardQueryTemplateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmCardQueryTemplateRequest;
$param_query_card_template_open_req = new QueryCardTemplateOpenReq;
$param_query_card_template_open_req->brand_id="33959";
$param_query_card_template_open_req->card_template_id="1231413";
$param_query_card_template_open_req->out_brand_id="33959";
$param_query_card_template_open_req->out_shop_id="4323434";
$param_query_card_template_open_req->shop_id="22342317";
$param_query_card_template_open_req->include_logical_delete="true";
$param_query_card_template_open_req->max_update_time="2019-01-01 11:11:11";
$param_query_card_template_open_req->physical_card_id="1234";
$req->setParamQueryCardTemplateOpenReq(json_encode($param_query_card_template_open_req));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.alsc.crm.card.query.template' \
-d 'partner_id=apidoc' \
-d 'sign=C6AE952B07912E51B94C10DBDDF80556' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A33%3A51' \
-d 'v=2.0' \
-d 'param_query_card_template_open_req=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaAlscCrmCardQueryTemplateRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.param_query_card_template_open_req=""
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.alsc.crm.card.query.template");
add_param(pRequest,"param_query_card_template_open_req","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alsc.crm.card.query.template', {
	'param_query_card_template_open_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_crm_card_query_template_response>
    <result>
        <biz_success>true</biz_success>
        <result>
            <card_template_id>374749</card_template_id>
            <card_type>MEMBER</card_type>
            <create_by>小李</create_by>
            <deleted>false</deleted>
            <expire_type>FIX</expire_type>
            <expire_value>15</expire_value>
            <ext_info>
                <empty></empty>
            </ext_info>
            <gmt_create>2019-01-01 11:11:11</gmt_create>
            <gmt_modified>2019-01-01 11:11:11</gmt_modified>
            <menu_id>342342</menu_id>
            <menu_limit_type>NO_LIMIT</menu_limit_type>
            <menu_switch>false</menu_switch>
            <name>会员卡模板1</name>
            <open_gift_switch>false</open_gift_switch>
            <opt_plan_id>3435345</opt_plan_id>
            <phy_card_fee_amount>20</phy_card_fee_amount>
            <phy_card_fee_back>false</phy_card_fee_back>
            <phy_card_fee_switch>false</phy_card_fee_switch>
            <pre_recharge_amount>5</pre_recharge_amount>
            <recharge_clear>false</recharge_clear>
            <recharge_rule_open_info>
                <card_type>1</card_type>
                <create_by>小李</create_by>
                <deduction_order>1</deduction_order>
                <deleted>false</deleted>
                <ext_info>
                    <empty></empty>
                </ext_info>
                <full_gift_switch>false</full_gift_switch>
                <gift_type>1</gift_type>
                <gmt_create>2019-01-01 11:11:11</gmt_create>
                <gmt_modified>2019-01-01 11:11:11</gmt_modified>
                <list_recharge_rule_detail_info_list>
                    <recharge_rule_detail_open_info>
                        <gift_point>10</gift_point>
                        <gift_value>20</gift_value>
                        <real_value>100</real_value>
                        <remark>备注信息</remark>
                    </recharge_rule_detail_open_info>
                </list_recharge_rule_detail_info_list>
                <pay_no_pwd_credit>200</pay_no_pwd_credit>
                <pay_no_pwd_switch>1</pay_no_pwd_switch>
                <rule_id>443234</rule_id>
                <rule_name>满10赠2</rule_name>
                <shop_id>543245</shop_id>
                <update_by>小李子</update_by>
                <out_shop_id>234</out_shop_id>
            </recharge_rule_open_info>
            <recharge_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </recharge_shop_ids>
            <recharge_switch>true</recharge_switch>
            <sell_price>20</sell_price>
            <sell_shop_group_id>23123</sell_shop_group_id>
            <sell_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </sell_shop_ids>
            <startexpire_type>FIX</startexpire_type>
            <status>SOLD</status>
            <update_by>小张</update_by>
            <use_limit_type>ACTIVED</use_limit_type>
            <use_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </use_shop_ids>
            <vouchers>
                <open_gift_voucher_open_info>
                    <num>5</num>
                    <voucher_id>123234</voucher_id>
                </open_gift_voucher_open_info>
            </vouchers>
            <wx_card_ext>
                <brand_logo>http://xxx.jpg</brand_logo>
                <general_bg_logo>http://xxx.jpg</general_bg_logo>
                <general_bg_switch>true</general_bg_switch>
                <paid_get_switch>true</paid_get_switch>
                <wx_level_bgs>
                    <wx_level_bg_open_info>
                        <bg_url>http://xxx.jpg</bg_url>
                        <level_id>234234</level_id>
                        <level_name>钻石卡</level_name>
                    </wx_level_bg_open_info>
                </wx_level_bgs>
            </wx_card_ext>
            <wx_card_switch>true</wx_card_switch>
            <out_recharge_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </out_recharge_shop_ids>
            <out_use_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </out_use_shop_ids>
            <out_sell_shop_ids>
                <string>111</string>
                <string>222</string>
                <string>333</string>
            </out_sell_shop_ids>
        </result>
        <result_code>200</result_code>
        <result_desc>成功</result_desc>
        <result_view>&quot;&quot;</result_view>
    </result>
</alibaba_alsc_crm_card_query_template_response>

{
    "alibaba_alsc_crm_card_query_template_response":{
        "result":{
            "biz_success":true,
            "result":{
                "card_template_id":"374749",
                "card_type":"MEMBER",
                "create_by":"小李",
                "deleted":false,
                "expire_type":"FIX",
                "expire_value":"15",
                "ext_info":{
                    "empty":
                },
                "gmt_create":"2019-01-01 11:11:11",
                "gmt_modified":"2019-01-01 11:11:11",
                "menu_id":"342342",
                "menu_limit_type":"NO_LIMIT",
                "menu_switch":false,
                "name":"会员卡模板1",
                "open_gift_switch":false,
                "opt_plan_id":"3435345",
                "phy_card_fee_amount":20,
                "phy_card_fee_back":false,
                "phy_card_fee_switch":false,
                "pre_recharge_amount":5,
                "recharge_clear":false,
                "recharge_rule_open_info":{
                    "card_type":"1",
                    "create_by":"小李",
                    "deduction_order":"1",
                    "deleted":false,
                    "ext_info":{
                        "empty":
                    },
                    "full_gift_switch":false,
                    "gift_type":"1",
                    "gmt_create":"2019-01-01 11:11:11",
                    "gmt_modified":"2019-01-01 11:11:11",
                    "list_recharge_rule_detail_info_list":{
                        "recharge_rule_detail_open_info":[
                            {
                                "gift_point":10,
                                "gift_value":20,
                                "real_value":100,
                                "remark":"备注信息"
                            }
                        ]
                    },
                    "pay_no_pwd_credit":200,
                    "pay_no_pwd_switch":1,
                    "rule_id":"443234",
                    "rule_name":"满10赠2",
                    "shop_id":"543245",
                    "update_by":"小李子",
                    "out_shop_id":"234"
                },
                "recharge_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                },
                "recharge_switch":true,
                "sell_price":20,
                "sell_shop_group_id":"23123",
                "sell_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                },
                "startexpire_type":"FIX",
                "status":"SOLD",
                "update_by":"小张",
                "use_limit_type":"ACTIVED",
                "use_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                },
                "vouchers":{
                    "open_gift_voucher_open_info":[
                        {
                            "num":5,
                            "voucher_id":"123234"
                        }
                    ]
                },
                "wx_card_ext":{
                    "brand_logo":"http:\/\/xxx.jpg",
                    "general_bg_logo":"http:\/\/xxx.jpg",
                    "general_bg_switch":true,
                    "paid_get_switch":true,
                    "wx_level_bgs":{
                        "wx_level_bg_open_info":[
                            {
                                "bg_url":"http:\/\/xxx.jpg",
                                "level_id":"234234",
                                "level_name":"钻石卡"
                            }
                        ]
                    }
                },
                "wx_card_switch":true,
                "out_recharge_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                },
                "out_use_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                },
                "out_sell_shop_ids":{
                    "string":[
                        "111",
                        "222",
                        "333"
                    ]
                }
            },
            "result_code":"200",
            "result_desc":"成功",
            "result_view":"\"\""
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

本地生活API

alibaba.alsc.crm.card.query.template (查询卡模板详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈