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

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
outer_rank_query_param	OuterRankQueryParam	必须			分销榜单查询参数
└ period String 可选 7 榜单统计周期，销量榜单时生效。销量榜单："7"-周榜，"30"-月榜；佣金榜单：“0”-实时榜 └ rank_type Number 必须 1 榜单类型。1-销量榜单；2-佣金榜单 └ cate_name String 可选食品生鲜商品分类，必须是以下枚举之一，不传默认为全部. 分类：全部/食品生鲜/居家日用/个护美妆/数码家电/母婴用玩/服饰箱包/其他

名称	类型	示例值	描述
result	Result		返回信息
└ success Boolean true 是否成功 model OuterRankVO [] 榜单信息 └ item_id Number 12345678 商品id └ rank_no Number 1 排名，从1开始 └ item_title String 测试商品商品标题 └ object_pic String xxx.img 商品图片 └ aduser_id Number 12345678 主播id └ ratio String 1.00% 佣金率 └ price String ￥1.23 商品价格 └ outer_commission_fee String ￥1.23 预估到手佣金 └ outer_plan_id Number 12345678 分销计划id └ msg_info String 系统错误错误信息 └ msg_code String System Error 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMatrixTcpOuterItemRankQueryRequest req = new AlibabaMatrixTcpOuterItemRankQueryRequest();
AlibabaMatrixTcpOuterItemRankQueryRequest.OuterRankQueryParam obj1 = new AlibabaMatrixTcpOuterItemRankQueryRequest.OuterRankQueryParam();
obj1.setPeriod("7");
obj1.setRankType(1L);
obj1.setCateName("食品生鲜");
req.setOuterRankQueryParam(obj1);
AlibabaMatrixTcpOuterItemRankQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMatrixTcpOuterItemRankQueryRequest req = new AlibabaMatrixTcpOuterItemRankQueryRequest();
AlibabaMatrixTcpOuterItemRankQueryRequest.OuterRankQueryParamDomain obj1 = new AlibabaMatrixTcpOuterItemRankQueryRequest.OuterRankQueryParamDomain();
obj1.Period = "7";
obj1.RankType = 1L;
obj1.CateName = "食品生鲜";
req.OuterRankQueryParam_ = obj1;
AlibabaMatrixTcpOuterItemRankQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMatrixTcpOuterItemRankQueryRequest;
$outer_rank_query_param = new OuterRankQueryParam;
$outer_rank_query_param->period="7";
$outer_rank_query_param->rank_type="1";
$outer_rank_query_param->cate_name="食品生鲜";
$req->setOuterRankQueryParam(json_encode($outer_rank_query_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.matrix.tcp.outer.item.rank.query' \
-d 'partner_id=apidoc' \
-d 'session=6b1cb4a0-5ace-4827-8297-f20d4a840352' \
-d 'sign=C99E5995FD2134068F26382F7A84BBA2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+04%3A02%3A38' \
-d 'v=2.0' \
-d 'outer_rank_query_param=null'

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

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

req.outer_rank_query_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.matrix.tcp.outer.item.rank.query");
add_param(pRequest,"outer_rank_query_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.matrix.tcp.outer.item.rank.query', {
	'outer_rank_query_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_matrix_tcp_outer_item_rank_query_response>
    <result>
        <success>true</success>
        <model>
            <outer_rank_v_o>
                <item_id>12345678</item_id>
                <rank_no>1</rank_no>
                <item_title>测试商品</item_title>
                <object_pic>xxx.img</object_pic>
                <aduser_id>12345678</aduser_id>
                <ratio>1.00%</ratio>
                <price>￥1.23</price>
                <outer_commission_fee>￥1.23</outer_commission_fee>
                <outer_plan_id>12345678</outer_plan_id>
            </outer_rank_v_o>
        </model>
        <msg_info>系统错误</msg_info>
        <msg_code>System Error</msg_code>
    </result>
</alibaba_matrix_tcp_outer_item_rank_query_response>

{
    "alibaba_matrix_tcp_outer_item_rank_query_response":{
        "result":{
            "success":true,
            "model":{
                "outer_rank_v_o":[
                    {
                        "item_id":12345678,
                        "rank_no":1,
                        "item_title":"测试商品",
                        "object_pic":"xxx.img",
                        "aduser_id":12345678,
                        "ratio":"1.00%",
                        "price":"￥1.23",
                        "outer_commission_fee":"￥1.23",
                        "outer_plan_id":12345678
                    }
                ]
            },
            "msg_info":"系统错误",
            "msg_code":"System Error"
        }
    }
}

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.matrix.tcp.outer.item.rank.query (淘宝直播分销商品榜单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈