淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
requestdata	String	可选	{"referer":"referer","clientId":"clientId","ip":"ip","bizInfo":{"isImageNote":"isImageNote","city":"city","latitude":"latitude","poiStatus":"poiStatus","poiScore":"poiScore","shopAddress":"shopAddress","updateTimestamp":"updateTimestamp","createTimestamp":"createTimestamp","poiSource":"poiSource","isShortVideo":"isShortVideo","shopname":"shopname","shopPhone":"shopPhone","category":"category","longitude":"longitude"},"userAgent":"userAgent","cityId":"cityId","sessionId":"sessionId","deviceId":"deviceId","userId":"userId","platform":"platform","url":"url","shopIdList":["123","456"],"functionId":"functionId","phone":"phone","requestId":"requestId"}		接入参数

名称	类型	示例值	描述
resultcode	String	SUCCESS	code
resultsuccess	Boolean	true	是否成功
resultmessage	String	niujia test	message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscKmsAccessRequest req = new AlibabaAlscKmsAccessRequest();
req.setRequestdata("{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}");
AlibabaAlscKmsAccessResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscKmsAccessRequest req = new AlibabaAlscKmsAccessRequest();
req.Requestdata = "{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}";
AlibabaAlscKmsAccessResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscKmsAccessRequest;
$req->setRequestdata("{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}");
$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=alibaba.alsc.kms.access' \
-d 'partner_id=apidoc' \
-d 'sign=393909511FC2D78E7A0593A6C56E049E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A37%3A16' \
-d 'v=2.0' \
-d 'requestdata=%7B%5C%22referer%5C%22%3A%5C%22referer%5C%22%2C%5C%22clientId%5C%22%3A%5C%22clientId%5C%22%2C%5C%22ip%5C%22%3A%5C%22ip%5C%22%2C%5C%22bizInfo%5C%22%3A%7B%5C%22isImageNote%5C%22%3A%5C%22isImageNote%5C%22%2C%5C%22city%5C%22%3A%5C%22city%5C%22%2C%5C%22latitude%5C%22%3A%5C%22latitude%5C%22%2C%5C%22poiStatus%5C%22%3A%5C%22poiStatus%5C%22%2C%5C%22poiScore%5C%22%3A%5C%22poiScore%5C%22%2C%5C%22shopAddress%5C%22%3A%5C%22shopAddress%5C%22%2C%5C%22updateTimestamp%5C%22%3A%5C%22updateTimestamp%5C%22%2C%5C%22createTimestamp%5C%22%3A%5C%22createTimestamp%5C%22%2C%5C%22poiSource%5C%22%3A%5C%22poiSource%5C%22%2C%5C%22isShortVideo%5C%22%3A%5C%22isShortVideo%5C%22%2C%5C%22shopname%5C%22%3A%5C%22shopname%5C%22%2C%5C%22shopPhone%5C%22%3A%5C%22shopPhone%5C%22%2C%5C%22category%5C%22%3A%5C%22category%5C%22%2C%5C%22longitude%5C%22%3A%5C%22longitude%5C%22%7D%2C%5C%22userAgent%5C%22%3A%5C%22userAgent%5C%22%2C%5C%22cityId%5C%22%3A%5C%22cityId%5C%22%2C%5C%22sessionId%5C%22%3A%5C%22sessionId%5C%22%2C%5C%22deviceId%5C%22%3A%5C%22deviceId%5C%22%2C%5C%22userId%5C%22%3A%5C%22userId%5C%22%2C%5C%22platform%5C%22%3A%5C%22platform%5C%22%2C%5C%22url%5C%22%3A%5C%22url%5C%22%2C%5C%22shopIdList%5C%22%3A%5B%5C%22123%5C%22%2C%5C%22456%5C%22%5D%2C%5C%22functionId%5C%22%3A%5C%22functionId%5C%22%2C%5C%22phone%5C%22%3A%5C%22phone%5C%22%2C%5C%22requestId%5C%22%3A%5C%22requestId%5C%22%7D'

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

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

req.requestdata="{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}"
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,"alibaba.alsc.kms.access");
add_param(pRequest,"requestdata","{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}");
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('alibaba.alsc.kms.access', {
	'requestdata':'{\"referer\":\"referer\",\"clientId\":\"clientId\",\"ip\":\"ip\",\"bizInfo\":{\"isImageNote\":\"isImageNote\",\"city\":\"city\",\"latitude\":\"latitude\",\"poiStatus\":\"poiStatus\",\"poiScore\":\"poiScore\",\"shopAddress\":\"shopAddress\",\"updateTimestamp\":\"updateTimestamp\",\"createTimestamp\":\"createTimestamp\",\"poiSource\":\"poiSource\",\"isShortVideo\":\"isShortVideo\",\"shopname\":\"shopname\",\"shopPhone\":\"shopPhone\",\"category\":\"category\",\"longitude\":\"longitude\"},\"userAgent\":\"userAgent\",\"cityId\":\"cityId\",\"sessionId\":\"sessionId\",\"deviceId\":\"deviceId\",\"userId\":\"userId\",\"platform\":\"platform\",\"url\":\"url\",\"shopIdList\":[\"123\",\"456\"],\"functionId\":\"functionId\",\"phone\":\"phone\",\"requestId\":\"requestId\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_kms_access_response>
    <resultcode>SUCCESS</resultcode>
    <resultsuccess>true</resultsuccess>
    <resultmessage>niujia test</resultmessage>
</alibaba_alsc_kms_access_response>

{
    "alibaba_alsc_kms_access_response":{
        "resultcode":"SUCCESS",
        "resultsuccess":true,
        "resultmessage":"niujia test"
    }
}

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

alibaba.alsc.kms.access (本地生活风控数据接入)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ