淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
adzone_id	Number	必须	123	mm_xxx_xxx_xxx的第3段数字
fields	String	必须	user_id,click_url	需返回的字段列表
platform	Number	可选	1	链接形式-1：PC，2：无线。默认为１
site_id	Number	必须	1	mm_xxx_xxx_xxx的第2段数字
unid	String	可选	demo	(该字段不开放)自定义输入串，英文和数字组成，长度不能大于12个字符，区分不同的推广渠道
user_ids	String	必须	123,456	卖家id串，用,分割，从taobao.tbk.shop.get接口获取user_id字段

名称	类型	示例值	描述
results	NTbkShop []		加入淘宝客的店铺
└ user_id Number 123 卖家id └ click_url String http://s.click.taobao.com/e=xxx 店铺推广链接

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScShopConvertRequest req = new TbkScShopConvertRequest();
req.setAdzoneId(123L);
req.setFields("user_id,click_url");
req.setPlatform(1L);
req.setSiteId(1L);
req.setUnid("demo");
req.setUserIds("123,456");
TbkScShopConvertResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScShopConvertRequest req = new TbkScShopConvertRequest();
req.AdzoneId = 123L;
req.Fields = "user_id,click_url";
req.Platform = 1L;
req.SiteId = 1L;
req.Unid = "demo";
req.UserIds = "123,456";
TbkScShopConvertResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScShopConvertRequest;
$req->setAdzoneId("123");
$req->setFields("user_id,click_url");
$req->setPlatform("1");
$req->setSiteId("1");
$req->setUnid("demo");
$req->setUserIds("123,456");
$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.tbk.sc.shop.convert' \
-d 'partner_id=apidoc' \
-d 'session=141a091d-857e-4004-b570-4ded9dc7cd87' \
-d 'sign=45ADE42031BF10CE9CE6D22CF22D3CAF' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+03%3A53%3A20' \
-d 'v=2.0' \
-d 'adzone_id=123' \
-d 'fields=user_id%2Cclick_url' \
-d 'platform=1' \
-d 'site_id=1' \
-d 'unid=demo' \
-d 'user_ids=123%2C456'

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

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

req.adzone_id=123
req.fields="user_id,click_url"
req.platform=1
req.site_id=1
req.unid="demo"
req.user_ids="123,456"
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.tbk.sc.shop.convert");
add_param(pRequest,"adzone_id","123");
add_param(pRequest,"fields","user_id,click_url");
add_param(pRequest,"platform","1");
add_param(pRequest,"site_id","1");
add_param(pRequest,"unid","demo");
add_param(pRequest,"user_ids","123,456");
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.tbk.sc.shop.convert', {
	'adzone_id':'123',
	'fields':'user_id,click_url',
	'platform':'1',
	'site_id':'1',
	'unid':'demo',
	'user_ids':'123,456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_shop_convert_response>
    <results>
        <n_tbk_shop>
            <user_id>123</user_id>
            <click_url>http://s.click.taobao.com/e=xxx</click_url>
        </n_tbk_shop>
    </results>
</tbk_sc_shop_convert_response>

{
    "tbk_sc_shop_convert_response":{
        "results":{
            "n_tbk_shop":[
                {
                    "user_id":123,
                    "click_url":"http:\/\/s.click.taobao.com\/e=xxx"
                }
            ]
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.invalid-parameter:adzone_id	adzone_id不正确	请填写与member_id和site_id匹配的adzone_id
isp.tbkapi-service-unavailable	内部服务不可用	稍后重试

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.sc.shop.convert (淘宝客-服务商-店铺链接转换)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ