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

请求地址：

环境	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	CategoryQueryRequest	必须			入参
└ category_id Number 可选 12345 类目id

名称	类型	示例值	描述
result	ApiResult		result
└ success Boolean true 接口调用成功/失败 └ err_code String systemError 接口错误码 └ err_msg String 系统错误接口错误描述 model XsdCatePropDTO [] 类目及相关属性 └ category_id Number 12345 类目id └ category_path String 一级类目->二级类目->三级类目->四级类目类目名称 category_props XsdCatPropertyDTO [] 类目属性列表 └ cat_property_id Number 123 类目属性项id └ cat_property_name String 颜色分类类目属性项名称 └ required_flag Number 1 是否必选 * 1:必填 0:非必填 └ allow_define_pic_flag Number 1 是否允许自定义属性图片 * 1:允许 0:不允许 └ cat_property_values String [{"propertyValueOrder":0,"propertyValueName":"白色","propertyValueId":28320,"class":"com.tc.txd.biz.client.domain.category.CategoryPropertyValueDTO"}] 类目属性值列表

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaXsdPlatformCategoryGetRequest req = new AlibabaXsdPlatformCategoryGetRequest();
AlibabaXsdPlatformCategoryGetRequest.CategoryQueryRequest obj1 = new AlibabaXsdPlatformCategoryGetRequest.CategoryQueryRequest();
obj1.setCategoryId(12345L);
req.setParam(obj1);
AlibabaXsdPlatformCategoryGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaXsdPlatformCategoryGetRequest req = new AlibabaXsdPlatformCategoryGetRequest();
AlibabaXsdPlatformCategoryGetRequest.CategoryQueryRequestDomain obj1 = new AlibabaXsdPlatformCategoryGetRequest.CategoryQueryRequestDomain();
obj1.CategoryId = 12345L;
req.Param_ = obj1;
AlibabaXsdPlatformCategoryGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaXsdPlatformCategoryGetRequest;
$param = new CategoryQueryRequest;
$param->category_id="12345";
$req->setParam(json_encode($param));
$resp = $c->execute($req, $sessionKey);

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.xsd.platform.category.get' \
-d 'partner_id=apidoc' \
-d 'session=88ea916d-20d8-4bcb-baac-72c74663000c' \
-d 'sign=DD1772C54D8BF67CE30D86F33077EF9B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-22+02%3A48%3A37' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.xsd.platform.category.get");
add_param(pRequest,"param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.xsd.platform.category.get', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_xsd_platform_category_get_response>
    <result>
        <success>true</success>
        <err_code>systemError</err_code>
        <err_msg>系统错误</err_msg>
        <model>
            <xsd_cate_prop_d_t_o>
                <category_id>12345</category_id>
                <category_path>一级类目-&gt;二级类目-&gt;三级类目-&gt;四级类目</category_path>
                <category_props>
                    <xsd_cat_property_d_t_o>
                        <cat_property_id>123</cat_property_id>
                        <cat_property_name>颜色分类</cat_property_name>
                        <required_flag>1</required_flag>
                        <allow_define_pic_flag>1</allow_define_pic_flag>
                        <cat_property_values>[{&quot;propertyValueOrder&quot;:0,&quot;propertyValueName&quot;:&quot;白色&quot;,&quot;propertyValueId&quot;:28320,&quot;class&quot;:&quot;com.tc.txd.biz.client.domain.category.CategoryPropertyValueDTO&quot;}]</cat_property_values>
                    </xsd_cat_property_d_t_o>
                </category_props>
            </xsd_cate_prop_d_t_o>
        </model>
    </result>
</alibaba_xsd_platform_category_get_response>

{
    "alibaba_xsd_platform_category_get_response":{
        "result":{
            "success":true,
            "err_code":"systemError",
            "err_msg":"系统错误",
            "model":{
                "xsd_cate_prop_d_t_o":[
                    {
                        "category_id":12345,
                        "category_path":"一级类目->二级类目->三级类目->四级类目",
                        "category_props":{
                            "xsd_cat_property_d_t_o":[
                                {
                                    "cat_property_id":123,
                                    "cat_property_name":"颜色分类",
                                    "required_flag":1,
                                    "allow_define_pic_flag":1,
                                    "cat_property_values":"[{\"propertyValueOrder\":0,\"propertyValueName\":\"白色\",\"propertyValueId\":28320,\"class\":\"com.tc.txd.biz.client.domain.category.CategoryPropertyValueDTO\"}]"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}

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.xsd.platform.category.get (淘鲜达平台类目属性查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈