淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
secret_version	Number	可选	1	秘钥版本号
random_num	String	必须	0ebbcccfee18d7ad1aebc5b875ffa906	伪随机数
customer_user_id	Number	可选	1111111	自定义用户id

名称	类型	示例值	描述
interval	Number	900	下次更新秘钥间隔，单位（秒）
max_interval	Number	1800	最长有效期，容灾使用，单位（秒）
secret	String	0ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa906	秘钥值
secret_version	Number	1	秘钥版本号
app_config	String	{"current_phone","2"}	app配置信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopSecretGetRequest req = new TopSecretGetRequest();
req.setSecretVersion(1L);
req.setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
req.setCustomerUserId(1111111L);
TopSecretGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TopSecretGetRequest req = new TopSecretGetRequest();
req.SecretVersion = 1L;
req.RandomNum = "0ebbcccfee18d7ad1aebc5b875ffa906";
req.CustomerUserId = 1111111L;
TopSecretGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopSecretGetRequest;
$req->setSecretVersion("1");
$req->setRandomNum("0ebbcccfee18d7ad1aebc5b875ffa906");
$req->setCustomerUserId("1111111");
$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=taobao.top.secret.get' \
-d 'partner_id=apidoc' \
-d 'session=ce756f97-db79-47fd-99a6-3538968d7887' \
-d 'sign=6F5B1A0ED21DC679AA77ACB8F9752D30' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+00%3A40%3A24' \
-d 'v=2.0' \
-d 'customer_user_id=1111111' \
-d 'random_num=0ebbcccfee18d7ad1aebc5b875ffa906' \
-d 'secret_version=1'

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

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

req.secret_version=1
req.random_num="0ebbcccfee18d7ad1aebc5b875ffa906"
req.customer_user_id=1111111
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,"taobao.top.secret.get");
add_param(pRequest,"secret_version","1");
add_param(pRequest,"random_num","0ebbcccfee18d7ad1aebc5b875ffa906");
add_param(pRequest,"customer_user_id","1111111");
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('taobao.top.secret.get', {
	'secret_version':'1',
	'random_num':'0ebbcccfee18d7ad1aebc5b875ffa906',
	'customer_user_id':'1111111'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<top_secret_get_response>
    <interval>900</interval>
    <max_interval>1800</max_interval>
    <secret>0ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa906</secret>
    <secret_version>1</secret_version>
    <app_config>{&quot;current_phone&quot;,&quot;2&quot;}</app_config>
</top_secret_get_response>

{
    "top_secret_get_response":{
        "interval":900,
        "max_interval":1800,
        "secret":"0ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa9060ebbcccfee18d7ad1aebc5b135ffa906",
        "secret_version":1,
        "app_config":"{\"current_phone\",\"2\"}"
    }
}

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

taobao.top.secret.get (获取TOP通道解密秘钥)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ