淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query	LoginQuery	可选			登录查询参数
└ identity String 可选 123 登录身份标识 └ system_type Number 可选 0 系统类型

名称	类型	示例值	描述
result	RCode	{}	返回结果包装体
data User4DataphinDTO {} 返回数据 └ user_id String 123 用户id，数据银行平台生成的baseid，非淘宝id └ account_name String 123 用户账号 └ parent_user_id String 123 父id，实际为空 └ display_name String zhangsan 展示名，实际为空 └ real_name String zhangsan 真名，实际为空 └ nick_name String zhangsan 昵称，实际为空 └ email String ee@qq.com 邮件，实际为空 └ mobile_phone String 123455 手机，实际为空 └ err_code Number 23 错误码 └ err_msg String 参数异常错误信息 └ code_class String success 错误类

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDatafactoryTenantSsoRequest req = new AlibabaDatafactoryTenantSsoRequest();
AlibabaDatafactoryTenantSsoRequest.LoginQuery obj1 = new AlibabaDatafactoryTenantSsoRequest.LoginQuery();
obj1.setIdentity("123");
obj1.setSystemType(0L);
req.setQuery(obj1);
AlibabaDatafactoryTenantSsoResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDatafactoryTenantSsoRequest req = new AlibabaDatafactoryTenantSsoRequest();
AlibabaDatafactoryTenantSsoRequest.LoginQueryDomain obj1 = new AlibabaDatafactoryTenantSsoRequest.LoginQueryDomain();
obj1.Identity = "123";
obj1.SystemType = 0L;
req.Query_ = obj1;
AlibabaDatafactoryTenantSsoResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDatafactoryTenantSsoRequest;
$query = new LoginQuery;
$query->identity="123";
$query->system_type="0";
$req->setQuery(json_encode($query));
$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.datafactory.tenant.sso' \
-d 'partner_id=apidoc' \
-d 'sign=50D53B534DF258D0B56182644BEE36AB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-16+04%3A24%3A27' \
-d 'v=2.0' \
-d 'query=%7B%7D'

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

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

req.query="{}"
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.datafactory.tenant.sso");
add_param(pRequest,"query","数据结构JSON示例");
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.datafactory.tenant.sso', {
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_datafactory_tenant_sso_response>
    <result>
        <data>
            <user_id>123</user_id>
            <account_name>123</account_name>
            <parent_user_id>123</parent_user_id>
            <display_name>zhangsan</display_name>
            <real_name>zhangsan</real_name>
            <nick_name>zhangsan</nick_name>
            <email>ee@qq.com</email>
            <mobile_phone>123455</mobile_phone>
        </data>
        <err_code>23</err_code>
        <err_msg>参数异常</err_msg>
        <code_class>success</code_class>
    </result>
</alibaba_datafactory_tenant_sso_response>

{
    "alibaba_datafactory_tenant_sso_response":{
        "result":{
            "data":{
                "user_id":"123",
                "account_name":"123",
                "parent_user_id":"123",
                "display_name":"zhangsan",
                "real_name":"zhangsan",
                "nick_name":"zhangsan",
                "email":"ee@qq.com",
                "mobile_phone":"123455"
            },
            "err_code":23,
            "err_msg":"参数异常",
            "code_class":"success"
        }
    }
}

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.datafactory.tenant.sso (登录态验证)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ