淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
proxy_app_key	String	必须	12345678		ISV的AppKey
body	byte[]	必须	字节流	最大长度：5242880	待签名的请求体，最大5M
algorithm	String	可选	HmacMD5	默认值：HmacMD5	签名算法，可选值：HmacMD5, HmacSHA1
signature	String	必须	481F8FDBCF801E20A6443B037345C91C		待验证的签名
charset	String	可选	utf-8	默认值：utf-8	字节流编码方式，可选值：utf-8, gbk

名称	类型	示例值	描述
valid	Boolean	true	签名是否有效
isv_id	Number	123	appkey拥有者ID
secret	String	123	验证成功后返回加密的secret信息，秘钥为signature的前8位

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
SignatureValidateRequest req = new SignatureValidateRequest();
req.setProxyAppKey("12345678");
req.setBody(new FileItem("/tmp/file.txt"));
req.setAlgorithm("HmacMD5");
req.setSignature("481F8FDBCF801E20A6443B037345C91C");
req.setCharset("utf-8");
SignatureValidateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
SignatureValidateRequest req = new SignatureValidateRequest();
req.ProxyAppKey = "12345678";
req.Body = new FileItem("/tmp/file.txt");
req.Algorithm = "HmacMD5";
req.Signature = "481F8FDBCF801E20A6443B037345C91C";
req.Charset = "utf-8";
SignatureValidateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new SignatureValidateRequest;
$req->setProxyAppKey("12345678");
//附件上传的机制参见PHP CURL文档，在文件路径前加@符号即可
$req->setBody(@fileLocation);
$req->setAlgorithm("HmacMD5");
$req->setSignature("481F8FDBCF801E20A6443B037345C91C");
$req->setCharset("utf-8");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:multipart/form-data;charset=utf-8' \
-F 'app_key=12129701' \
-F 'format=json' \
-F 'method=taobao.signature.validate' \
-F 'partner_id=apidoc' \
-F 'sign=ECF01CB04A1AF56DC1BB5B73DB5CB2D5' \
-F 'sign_method=hmac' \
-F 'timestamp=2024-05-07+00%3A13%3A49' \
-F 'v=2.0' \
-F 'algorithm=HmacMD5' \
-F 'charset=utf-8' \
-F 'proxy_app_key=12345678' \
-F 'signature=481F8FDBCF801E20A6443B037345C91C' \
-F 'body=@/tmp/file.txt'

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

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

req.proxy_app_key="12345678"
req.body=top.api.FileItem('abc.jpg',open('abc.jpg','rb'))
req.algorithm="HmacMD5"
req.signature="481F8FDBCF801E20A6443B037345C91C"
req.charset="utf-8"
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,"taobao.signature.validate");
add_param(pRequest,"proxy_app_key","12345678");
add_file_param(pRequest,"body","文件内容");
add_param(pRequest,"algorithm","HmacMD5");
add_param(pRequest,"signature","481F8FDBCF801E20A6443B037345C91C");
add_param(pRequest,"charset","utf-8");
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('taobao.signature.validate', {
	'proxy_app_key':'12345678',
	'body':'文件内容',
	'algorithm':'HmacMD5',
	'signature':'481F8FDBCF801E20A6443B037345C91C',
	'charset':'utf-8'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<signature_validate_response>
    <valid>true</valid>
    <isv_id>123</isv_id>
    <secret>123</secret>
</signature_validate_response>

{
    "signature_validate_response":{
        "valid":true,
        "isv_id":123,
        "secret":"123"
    }
}

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.signature.validate (验证API请求签名是否正确)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ