淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
device_value	String	可选	xxx	加密后的值(ALIPAY_ID除外)，需用MD5加密，32位小写
device_type	String	可选	IMEI	入参类型(该模式下返回的结果为模糊匹配结果，和实际情况可能存在误差)： 1. IMEI 2. IDFA 3. OAID 4. 联系方式 5. ALIPAY_ID
special_id	String	可选	2323	会员运营ID(入参类型，会员运营ID，渠道关系ID三选一)
relation_id	String	可选	2342	渠道关系ID(入参类型，会员运营ID，渠道关系ID三选一)

名称	类型	示例值	描述
result_list	MapData []		resultList
└ track_pool_goods String 2341211 跟踪池的官方货品推荐(物料id即material_id)，在物料精选API中使用 └ bonus_pool_potential_score String A 奖励池收益指数(锁佣周期内产生的预估收益，以实际收益为准) └ bonus_pool_locked String 1 奖励池当前是否被锁定 1标识被他人锁定，0标识未锁定，2标识被自己锁定，3标识未识别

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgLockinDetailsGetRequest req = new TbkDgLockinDetailsGetRequest();
req.setDeviceValue("xxx");
req.setDeviceType("IMEI");
req.setSpecialId("2323");
req.setRelationId("2342");
TbkDgLockinDetailsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgLockinDetailsGetRequest req = new TbkDgLockinDetailsGetRequest();
req.DeviceValue = "xxx";
req.DeviceType = "IMEI";
req.SpecialId = "2323";
req.RelationId = "2342";
TbkDgLockinDetailsGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgLockinDetailsGetRequest;
$req->setDeviceValue("xxx");
$req->setDeviceType("IMEI");
$req->setSpecialId("2323");
$req->setRelationId("2342");
$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.dg.lockin.details.get' \
-d 'partner_id=apidoc' \
-d 'sign=A8621AED7CDC5F40CD529D3224EF42CE' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+22%3A11%3A31' \
-d 'v=2.0' \
-d 'device_type=IMEI' \
-d 'device_value=xxx' \
-d 'relation_id=2342' \
-d 'special_id=2323'

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

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

req.device_value="xxx"
req.device_type="IMEI"
req.special_id="2323"
req.relation_id="2342"
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.dg.lockin.details.get");
add_param(pRequest,"device_value","xxx");
add_param(pRequest,"device_type","IMEI");
add_param(pRequest,"special_id","2323");
add_param(pRequest,"relation_id","2342");
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.dg.lockin.details.get', {
	'device_value':'xxx',
	'device_type':'IMEI',
	'special_id':'2323',
	'relation_id':'2342'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_lockin_details_get_response>
    <result_list>
        <map_data>
            <track_pool_goods>2341211</track_pool_goods>
            <bonus_pool_potential_score>A</bonus_pool_potential_score>
            <bonus_pool_locked>1</bonus_pool_locked>
        </map_data>
    </result_list>
</tbk_dg_lockin_details_get_response>

{
    "tbk_dg_lockin_details_get_response":{
        "result_list":{
            "map_data":[
                {
                    "track_pool_goods":"2341211",
                    "bonus_pool_potential_score":"A",
                    "bonus_pool_locked":"1"
                }
            ]
        }
    }
}

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.dg.lockin.details.get (淘宝客-推广者-锁佣空间)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ