淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
tk_domain	Number	必须	1	淘客业务域，1-导购 2-流量 3-社群 4-代理 5-返利
source_type	Number	可选	1	媒体侧用户id，固定传1
source_values	String	可选	123,123	原始用户id值，传入多个时请使用英文逗号分隔，最多不超过10个
main_accountid	Number	可选	1231231	联盟账号组的主账号ID,传入时使用账号组维度创建
device_type	String	可选	1	设备号类型，1-OAID 不加密 2-IMEI md5加密 3-IDFA md5加密 4-CAID 5-CAID2 6-OAID md5加密
device_value	String	可选	123-231-2313cdsa	设备值
caid_version	String	可选	20211113	CAID版本号，使用CAID时必传
group_type	Number	可选	1	1-媒体账号组，2-自定义账号组。main_accountid不空其他值默认为媒体账号组

名称	类型	示例值	描述
result_list	UvIdGenerateRes []		result_list
└ error_message String miss source_values 错误描述 └ encrypted_uvid String vnt22Qurt6YYmVhBmLnBrsNPL9Ra 加密用户标识 └ source_value String 123 入参的原始用户id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkUvidEncryptRequest req = new TbkUvidEncryptRequest();
req.setTkDomain(1L);
req.setSourceType(1L);
req.setSourceValues("123,123");
req.setMainAccountid(1231231L);
req.setDeviceType("1");
req.setDeviceValue("123-231-2313cdsa");
req.setCaidVersion("20211113");
req.setGroupType(1L);
TbkUvidEncryptResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkUvidEncryptRequest req = new TbkUvidEncryptRequest();
req.TkDomain = 1L;
req.SourceType = 1L;
req.SourceValues = "123,123";
req.MainAccountid = 1231231L;
req.DeviceType = "1";
req.DeviceValue = "123-231-2313cdsa";
req.CaidVersion = "20211113";
req.GroupType = 1L;
TbkUvidEncryptResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkUvidEncryptRequest;
$req->setTkDomain("1");
$req->setSourceType("1");
$req->setSourceValues("123,123");
$req->setMainAccountid("1231231");
$req->setDeviceType("1");
$req->setDeviceValue("123-231-2313cdsa");
$req->setCaidVersion("20211113");
$req->setGroupType("1");
$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.tbk.uvid.encrypt' \
-d 'partner_id=apidoc' \
-d 'sign=60FF8B102A48C078C4380195E303FA54' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+16%3A01%3A31' \
-d 'v=2.0' \
-d 'caid_version=20211113' \
-d 'device_type=1' \
-d 'device_value=123-231-2313cdsa' \
-d 'group_type=1' \
-d 'main_accountid=1231231' \
-d 'source_type=1' \
-d 'source_values=123%2C123' \
-d 'tk_domain=1'

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

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

req.tk_domain=1
req.source_type=1
req.source_values="123,123"
req.main_accountid=1231231
req.device_type="1"
req.device_value="123-231-2313cdsa"
req.caid_version="20211113"
req.group_type=1
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.tbk.uvid.encrypt");
add_param(pRequest,"tk_domain","1");
add_param(pRequest,"source_type","1");
add_param(pRequest,"source_values","123,123");
add_param(pRequest,"main_accountid","1231231");
add_param(pRequest,"device_type","1");
add_param(pRequest,"device_value","123-231-2313cdsa");
add_param(pRequest,"caid_version","20211113");
add_param(pRequest,"group_type","1");
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.tbk.uvid.encrypt', {
	'tk_domain':'1',
	'source_type':'1',
	'source_values':'123,123',
	'main_accountid':'1231231',
	'device_type':'1',
	'device_value':'123-231-2313cdsa',
	'caid_version':'20211113',
	'group_type':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_uvid_encrypt_response>
    <result_list>
        <uv_id_generate_res>
            <error_message>miss source_values</error_message>
            <encrypted_uvid>vnt22Qurt6YYmVhBmLnBrsNPL9Ra</encrypted_uvid>
            <source_value>123</source_value>
        </uv_id_generate_res>
    </result_list>
</tbk_uvid_encrypt_response>

{
    "tbk_uvid_encrypt_response":{
        "result_list":{
            "uv_id_generate_res":[
                {
                    "error_message":"miss source_values",
                    "encrypted_uvid":"vnt22Qurt6YYmVhBmLnBrsNPL9Ra",
                    "source_value":"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.tbk.uvid.encrypt (淘宝客-推广者-加密用户标识生成)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ