文档中心 > API类目 > 淘宝客API

taobao.tbk.sc.private.tpwd.create (淘宝客-服务商-加密淘口令生成)

提供加密淘口令生成接口。提交需要生成淘口令的url等参数，生成淘口令，其中关键信息为￥SADadW￥，后续可基于淘口令进行文案包装组装用于传播。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
url	String	必须	https://s.click.taobao.com/YI3Uopu	联盟官方渠道获取的淘客推广链接，请注意，不要随意篡改官方生成的链接，否则可能无法生成淘口令
text	String	可选	noMeaningValue	兼容旧版本api参数，无实际作用
logo	String	可选	noMeaningValue	兼容旧版本api参数，无实际作用
ext	String	可选	noMeaningValue	兼容旧版本api参数，无实际作用
user_id	String	可选	noMeaningValue	兼容旧版本api参数，无实际作用

响应参数

名称	类型	示例值	描述
data	MapData		返回结果对象
└ model String 8緮置内容￥hxlgccEumBB￥达开?τao寶?或掂击炼接 https://m.tb.cn/h.VvkiWSm 至浏.览览.器【618超级红包】针对苹果ios14及以上版本的苹果设备，手淘将按照示例值信息格式读取淘口令(需包含：数字+羊角符+url，识别规则可能根据ios情况变更)。如需更改淘口令内文案、url等内容，请务必先验证更改后的淘口令在手淘可被识别打开！ └ password_simple String ￥SIH6XbwRfyt￥非苹果ios14以上版本的设备（即其他ios版本、Android系统等），可以用此淘口令正常在复制到手淘打开

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScPrivateTpwdCreateRequest req = new TbkScPrivateTpwdCreateRequest();
req.setUrl("https://s.click.taobao.com/YI3Uopu");
req.setText("noMeaningValue");
req.setLogo("noMeaningValue");
req.setExt("noMeaningValue");
req.setUserId("noMeaningValue");
TbkScPrivateTpwdCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScPrivateTpwdCreateRequest req = new TbkScPrivateTpwdCreateRequest();
req.Url = "https://s.click.taobao.com/YI3Uopu";
req.Text = "noMeaningValue";
req.Logo = "noMeaningValue";
req.Ext = "noMeaningValue";
req.UserId = "noMeaningValue";
TbkScPrivateTpwdCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScPrivateTpwdCreateRequest;
$req->setUrl("https://s.click.taobao.com/YI3Uopu");
$req->setText("noMeaningValue");
$req->setLogo("noMeaningValue");
$req->setExt("noMeaningValue");
$req->setUserId("noMeaningValue");
$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.private.tpwd.create' \
-d 'partner_id=apidoc' \
-d 'session=d1a594d9-470a-4692-b7d1-9e2290e81626' \
-d 'sign=42293B9622F8EA0684F4FD402E7BB46D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+16%3A25%3A31' \
-d 'v=2.0' \
-d 'ext=noMeaningValue' \
-d 'logo=noMeaningValue' \
-d 'text=noMeaningValue' \
-d 'url=https%3A%2F%2Fs.click.taobao.com%2FYI3Uopu' \
-d 'user_id=noMeaningValue'

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

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

req.url="https://s.click.taobao.com/YI3Uopu"
req.text="noMeaningValue"
req.logo="noMeaningValue"
req.ext="noMeaningValue"
req.user_id="noMeaningValue"
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.private.tpwd.create");
add_param(pRequest,"url","https://s.click.taobao.com/YI3Uopu");
add_param(pRequest,"text","noMeaningValue");
add_param(pRequest,"logo","noMeaningValue");
add_param(pRequest,"ext","noMeaningValue");
add_param(pRequest,"user_id","noMeaningValue");
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.private.tpwd.create', {
	'url':'https://s.click.taobao.com/YI3Uopu',
	'text':'noMeaningValue',
	'logo':'noMeaningValue',
	'ext':'noMeaningValue',
	'user_id':'noMeaningValue'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<tbk_sc_private_tpwd_create_response>
    <data>
        <model>8緮置内容￥hxlgccEumBB￥达开?τao寶?或掂击炼接 https://m.tb.cn/h.VvkiWSm 至浏.览览.器【618超级红包】</model>
        <password_simple>￥SIH6XbwRfyt￥</password_simple>
    </data>
</tbk_sc_private_tpwd_create_response>

{
    "tbk_sc_private_tpwd_create_response":{
        "data":{
            "model":"8緮置内容￥hxlgccEumBB￥达开?τao寶?或掂击炼接 https:\/\/m.tb.cn\/h.VvkiWSm 至浏.览览.器【618超级红包】",
            "password_simple":"￥SIH6XbwRfyt￥"
        }
    }
}

异常示例

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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

淘宝客API

taobao.tbk.sc.private.tpwd.create (淘宝客-服务商-加密淘口令生成)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ