淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
hello_req_dto	HelloReqDto	可选		111
└ id_input Number 可选 1 111 └ price_double_input Number 可选 2.0 111 └ any_word String 可选 ss 111 └ price_big_input String 可选 2.0 111
param1	Boolean	可选	true	111

名称	类型	示例值	描述
result	HelloRespDto		111
└ id Number 1 111
success1	Boolean	true	111
error_code1	Number	0	111
error_msg1	String	success	111

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopTopadminTesthelloworldRequest req = new TopTopadminTesthelloworldRequest();
TopTopadminTesthelloworldRequest.HelloReqDto obj1 = new TopTopadminTesthelloworldRequest.HelloReqDto();
obj1.setIdInput(1L);
obj1.setPriceDoubleInput(2.0L);
obj1.setAnyWord("ss");
obj1.setPriceBigInput("2.0");
req.setHelloReqDto(obj1);
req.setParam1(true);
TopTopadminTesthelloworldResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TopTopadminTesthelloworldRequest req = new TopTopadminTesthelloworldRequest();
TopTopadminTesthelloworldRequest.HelloReqDtoDomain obj1 = new TopTopadminTesthelloworldRequest.HelloReqDtoDomain();
obj1.IdInput = 1L;
obj1.PriceDoubleInput = 2.0L;
obj1.AnyWord = "ss";
obj1.PriceBigInput = "2.0";
req.HelloReqDto_ = obj1;
req.Param1 = true;
TopTopadminTesthelloworldResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopTopadminTesthelloworldRequest;
$hello_req_dto = new HelloReqDto;
$hello_req_dto->id_input="1";
$hello_req_dto->price_double_input="2.0";
$hello_req_dto->any_word="ss";
$hello_req_dto->price_big_input="2.0";
$req->setHelloReqDto(json_encode($hello_req_dto));
$req->setParam1("true");
$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=taobao.top.topadmin.testhelloworld' \
-d 'partner_id=apidoc' \
-d 'sign=FF281C5551663650715B9EFB74AA0A32' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+00%3A56%3A27' \
-d 'v=2.0' \
-d 'hello_req_dto=null' \
-d 'param1=true'

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

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

req.hello_req_dto="数据结构示例JSON格式"
req.param1=true
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.top.topadmin.testhelloworld");
add_param(pRequest,"hello_req_dto","数据结构JSON示例");
add_param(pRequest,"param1","true");
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.top.topadmin.testhelloworld', {
	'hello_req_dto':'数据结构JSON示例',
	'param1':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<top_topadmin_testhelloworld_response>
    <result>
        <id>1</id>
    </result>
    <success1>true</success1>
    <error_code1>0</error_code1>
    <error_msg1>success</error_msg1>
</top_topadmin_testhelloworld_response>

{
    "top_topadmin_testhelloworld_response":{
        "result":{
            "id":1
        },
        "success1":true,
        "error_code1":0,
        "error_msg1":"success"
    }
}

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.topadmin.testhelloworld (打印HelloWorld)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ