淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
trigger_code	String	必须	AAAAAAGGCxGWPSEFYr2ABCAC		事件编码
content	Json	必须	{ "tradeId": "12345678", "buyAmount": "1", "auctionTitle": "商品标题" }		事件内容

名称	类型	示例值	描述
data	EventPublishResponse		事件返回值
response_list ProcessResponse [] 流程返回值列表 └ process_instance_id String f8f622f6-b784-4c3e-964f-be3ae6a92ead 流程实例ID └ process_success Boolean true 流程执行是否成功 └ biz_success Boolean true 业务是否成功 └ process_error_code String 500 流程错误码 └ process_error_msg String system-error 流程错误信息 └ process_remark String 系统开小差了流程备注 └ process_data Json {"title":"abc"} 流程返回值 └ trace_id String 5706620716801475064311088bf6ab traceId └ execute_process Boolean true 是否触发工作流

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopEventPublishRequest req = new TopEventPublishRequest();
req.setTriggerCode("AAAAAAGGCxGWPSEFYr2ABCAC");
req.setContentString("{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }");
TopEventPublishResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TopEventPublishRequest req = new TopEventPublishRequest();
req.TriggerCode = "AAAAAAGGCxGWPSEFYr2ABCAC";
req.Content = "{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }";
TopEventPublishResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopEventPublishRequest;
$req->setTriggerCode("AAAAAAGGCxGWPSEFYr2ABCAC");
$req->setContent("{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }");
$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.event.publish' \
-d 'partner_id=apidoc' \
-d 'session=1c0587a4-823d-4b9d-a944-18c68032e932' \
-d 'sign=8B5C9E14D19D1B18687D99A87B658FC4' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+02%3A00%3A10' \
-d 'v=2.0' \
-d 'content=%7B+++%5C%22tradeId%5C%22%3A+%5C%2212345678%5C%22%2C+++%5C%22buyAmount%5C%22%3A+%5C%221%5C%22%2C+++%5C%22auctionTitle%5C%22%3A+%5C%22%E5%95%86%E5%93%81%E6%A0%87%E9%A2%98%5C%22+%7D' \
-d 'trigger_code=AAAAAAGGCxGWPSEFYr2ABCAC'

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

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

req.trigger_code="AAAAAAGGCxGWPSEFYr2ABCAC"
req.content="{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }"
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.event.publish");
add_param(pRequest,"trigger_code","AAAAAAGGCxGWPSEFYr2ABCAC");
add_param(pRequest,"content","{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }");
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.event.publish', {
	'trigger_code':'AAAAAAGGCxGWPSEFYr2ABCAC',
	'content':'{   \"tradeId\": \"12345678\",   \"buyAmount\": \"1\",   \"auctionTitle\": \"商品标题\" }'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<top_event_publish_response>
    <data>
        <response_list>
            <process_response>
                <process_instance_id>f8f622f6-b784-4c3e-964f-be3ae6a92ead</process_instance_id>
                <process_success>true</process_success>
                <biz_success>true</biz_success>
                <process_error_code>500</process_error_code>
                <process_error_msg>system-error</process_error_msg>
                <process_remark>系统开小差了</process_remark>
                <process_data>{&quot;title&quot;:&quot;abc&quot;}</process_data>
            </process_response>
        </response_list>
        <trace_id>5706620716801475064311088bf6ab</trace_id>
        <execute_process>true</execute_process>
    </data>
</top_event_publish_response>

{
    "top_event_publish_response":{
        "data":{
            "response_list":{
                "process_response":[
                    {
                        "process_instance_id":"f8f622f6-b784-4c3e-964f-be3ae6a92ead",
                        "process_success":true,
                        "biz_success":true,
                        "process_error_code":"500",
                        "process_error_msg":"system-error",
                        "process_remark":"系统开小差了",
                        "process_data":"{\"title\":\"abc\"}"
                    }
                ]
            },
            "trace_id":"5706620716801475064311088bf6ab",
            "execute_process":true
        }
    }
}

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.event.publish (同步事件发布)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ