淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
pid	String	可选	mm_1111_0_0	如有pid，则查询pid下的relationid名单；如没有pid，则查询appkey关联userid下的pid名单
offset	Number	必须	0	分页参数
limit	Number	必须	1000	分页参数，一次最多不能超过1000

名称	类型	示例值	描述
result	Result	无	无
status_list DataMap [] x x └ pid String mm_1110_0_0 当入参不传pid的时候返回，表示账号关联的pid └ rid String 222 当入参传入pid的时候返回，表示pid关联的relationId └ status String 0 0表示预警，1表示拦截，如果名单中同一个淘客同时有拦截和预警信息，以拦截为准

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgTpwdRiskReportRequest req = new TbkDgTpwdRiskReportRequest();
req.setPid("mm_1111_0_0");
req.setOffset(0L);
req.setLimit(1000L);
TbkDgTpwdRiskReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgTpwdRiskReportRequest req = new TbkDgTpwdRiskReportRequest();
req.Pid = "mm_1111_0_0";
req.Offset = 0L;
req.Limit = 1000L;
TbkDgTpwdRiskReportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgTpwdRiskReportRequest;
$req->setPid("mm_1111_0_0");
$req->setOffset("0");
$req->setLimit("1000");
$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.tpwd.risk.report' \
-d 'partner_id=apidoc' \
-d 'sign=569022A97393513DEA900F3FA2B80351' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+20%3A19%3A44' \
-d 'v=2.0' \
-d 'limit=1000' \
-d 'offset=0' \
-d 'pid=mm_1111_0_0'

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

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

req.pid="mm_1111_0_0"
req.offset=0
req.limit=1000
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.tpwd.risk.report");
add_param(pRequest,"pid","mm_1111_0_0");
add_param(pRequest,"offset","0");
add_param(pRequest,"limit","1000");
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.tpwd.risk.report', {
	'pid':'mm_1111_0_0',
	'offset':'0',
	'limit':'1000'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_tpwd_risk_report_response>
    <result>
        <status_list>
            <data_map>
                <pid>mm_1110_0_0</pid>
                <rid>222</rid>
                <status>0</status>
            </data_map>
        </status_list>
    </result>
</tbk_dg_tpwd_risk_report_response>

{
    "tbk_dg_tpwd_risk_report_response":{
        "result":{
            "status_list":{
                "data_map":[
                    {
                        "pid":"mm_1110_0_0",
                        "rid":"222",
                        "status":"0"
                    }
                ]
            }
        }
    }
}

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.tpwd.risk.report (淘宝客-推广者-淘口令预警及拦截查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ