淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
hid	Number	可选	1000	默认值：0	havanaid
sso_token_login_request	SsoTokenLoginRequest	可选			request
└ client_ip String 可选 client_ip 客户端ip └ device_id String 可选 device_id 设备id └ device_name String 可选 device_name 设备名 └ hid Number 可选 1000 havanaid └ master_app_key String 可选 master_app_key 主客户端appkey └ master_t Number 可选 100 主客户端生成时间戳 └ slave_app_key String 可选 slave_app_key 从客户端appkey └ slave_t Number 可选 0 从客户端生成时间戳 └ sso_token String 可选 sso_token ssoToken └ sso_type String 可选 sso_type ssoToken类型 └ sso_version String 可选 sso_version ssoToken版本 └ uuid String 可选 uuid uuid └ version Number 可选 0 version └ sso_sign String 可选 0 签名
risk_control_info	RiskControlInfo	可选			风控信息
└ hard_umid Boolean 可选 false hard_umid └ imei String 可选 imei imei └ ip String 可选 ip ip └ latitude String 可选 latitude latitude └ longitude String 可选 longitude longitude └ mac String 可选 mac mac └ os_name String 可选 os_name os_name └ os_version String 可选 os_version os_version └ ssid String 可选 ssid ssid └ umid String 可选 umid umid └ umid_token String 可选 umid_token umid_token └ user_agent String 可选 user_agent user_agent └ wua String 可选 wua wua
ext	Json	可选	ext		扩展信息

名称	类型	示例值	描述
result	HavanaLoginResult	result	result
└ action_type String action_type action_type └ code Number code 结果code └ code_group String code_group 结果code分组 └ message String message 结果msg └ msg_code String msg_code 结果msgcode └ msg_info String msg_info msg信息 return_value MUnifyLoginResponse return_value return_value └ hid Number 1000 havanaid └ data String data 结果数据集 └ token String token token └ sid String sid sid └ site String site site └ ext_map String ext_map 扩展数据集 └ show_login_id String show_login_id 展示外标 └ display_nick String display_nick 展示nick └ taobao_nick String taobao_nick taobaoNick └ sso_token String sso_token ssoToken └ alipay_account_no String alipayAccountNo 支付宝卡号 └ success Boolean success success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAccountSsotokenInfoRequest req = new AlibabaAccountSsotokenInfoRequest();
req.setHid(1000L);
AlibabaAccountSsotokenInfoRequest.SsoTokenLoginRequest obj1 = new AlibabaAccountSsotokenInfoRequest.SsoTokenLoginRequest();
obj1.setClientIp("client_ip");
obj1.setDeviceId("device_id");
obj1.setDeviceName("device_name");
obj1.setHid(1000L);
obj1.setMasterAppKey("master_app_key");
obj1.setMasterT(100L);
obj1.setSlaveAppKey("slave_app_key");
obj1.setSlaveT(0L);
obj1.setSsoToken("sso_token");
obj1.setSsoType("sso_type");
obj1.setSsoVersion("sso_version");
obj1.setUuid("uuid");
obj1.setVersion(0L);
obj1.setSsoSign("0");
req.setSsoTokenLoginRequest(obj1);
AlibabaAccountSsotokenInfoRequest.RiskControlInfo obj2 = new AlibabaAccountSsotokenInfoRequest.RiskControlInfo();
obj2.setHardUmid(false);
obj2.setImei("imei");
obj2.setIp("ip");
obj2.setLatitude("latitude");
obj2.setLongitude("longitude");
obj2.setMac("mac");
obj2.setOsName("os_name");
obj2.setOsVersion("os_version");
obj2.setSsid("ssid");
obj2.setUmid("umid");
obj2.setUmidToken("umid_token");
obj2.setUserAgent("user_agent");
obj2.setWua("wua");
req.setRiskControlInfo(obj2);
req.setExtString("ext");
AlibabaAccountSsotokenInfoResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAccountSsotokenInfoRequest req = new AlibabaAccountSsotokenInfoRequest();
req.Hid = 1000L;
AlibabaAccountSsotokenInfoRequest.SsoTokenLoginRequestDomain obj1 = new AlibabaAccountSsotokenInfoRequest.SsoTokenLoginRequestDomain();
obj1.ClientIp = "client_ip";
obj1.DeviceId = "device_id";
obj1.DeviceName = "device_name";
obj1.Hid = 1000L;
obj1.MasterAppKey = "master_app_key";
obj1.MasterT = 100L;
obj1.SlaveAppKey = "slave_app_key";
obj1.SlaveT = 0L;
obj1.SsoToken = "sso_token";
obj1.SsoType = "sso_type";
obj1.SsoVersion = "sso_version";
obj1.Uuid = "uuid";
obj1.Version = 0L;
obj1.SsoSign = "0";
req.SsoTokenLoginRequest_ = obj1;
AlibabaAccountSsotokenInfoRequest.RiskControlInfoDomain obj2 = new AlibabaAccountSsotokenInfoRequest.RiskControlInfoDomain();
obj2.HardUmid = false;
obj2.Imei = "imei";
obj2.Ip = "ip";
obj2.Latitude = "latitude";
obj2.Longitude = "longitude";
obj2.Mac = "mac";
obj2.OsName = "os_name";
obj2.OsVersion = "os_version";
obj2.Ssid = "ssid";
obj2.Umid = "umid";
obj2.UmidToken = "umid_token";
obj2.UserAgent = "user_agent";
obj2.Wua = "wua";
req.RiskControlInfo_ = obj2;
req.Ext = "ext";
AlibabaAccountSsotokenInfoResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAccountSsotokenInfoRequest;
$req->setHid("1000");
$sso_token_login_request = new SsoTokenLoginRequest;
$sso_token_login_request->client_ip="client_ip";
$sso_token_login_request->device_id="device_id";
$sso_token_login_request->device_name="device_name";
$sso_token_login_request->hid="1000";
$sso_token_login_request->master_app_key="master_app_key";
$sso_token_login_request->master_t="100";
$sso_token_login_request->slave_app_key="slave_app_key";
$sso_token_login_request->slave_t="0";
$sso_token_login_request->sso_token="sso_token";
$sso_token_login_request->sso_type="sso_type";
$sso_token_login_request->sso_version="sso_version";
$sso_token_login_request->uuid="uuid";
$sso_token_login_request->version="0";
$sso_token_login_request->sso_sign="0";
$req->setSsoTokenLoginRequest(json_encode($sso_token_login_request));
$risk_control_info = new RiskControlInfo;
$risk_control_info->hard_umid="false";
$risk_control_info->imei="imei";
$risk_control_info->ip="ip";
$risk_control_info->latitude="latitude";
$risk_control_info->longitude="longitude";
$risk_control_info->mac="mac";
$risk_control_info->os_name="os_name";
$risk_control_info->os_version="os_version";
$risk_control_info->ssid="ssid";
$risk_control_info->umid="umid";
$risk_control_info->umid_token="umid_token";
$risk_control_info->user_agent="user_agent";
$risk_control_info->wua="wua";
$req->setRiskControlInfo(json_encode($risk_control_info));
$req->setExt("ext");
$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.account.ssotoken.info' \
-d 'partner_id=apidoc' \
-d 'sign=EF4FC91E122242DE8312EE385218D34D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A53%3A46' \
-d 'v=2.0' \
-d 'ext=ext' \
-d 'hid=1000' \
-d 'risk_control_info=null' \
-d 'sso_token_login_request=null'

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

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

req.hid=1000
req.sso_token_login_request=""
req.risk_control_info=""
req.ext="ext"
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.account.ssotoken.info");
add_param(pRequest,"hid","1000");
add_param(pRequest,"sso_token_login_request","数据结构JSON示例");
add_param(pRequest,"risk_control_info","数据结构JSON示例");
add_param(pRequest,"ext","ext");
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.account.ssotoken.info', {
	'hid':'1000',
	'sso_token_login_request':'数据结构JSON示例',
	'risk_control_info':'数据结构JSON示例',
	'ext':'ext'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_account_ssotoken_info_response>
    <result>
        <action_type>action_type</action_type>
        <code>code</code>
        <code_group>code_group</code_group>
        <message>message</message>
        <msg_code>msg_code</msg_code>
        <msg_info>msg_info</msg_info>
        <return_value>
            <hid>1000</hid>
            <data>data</data>
            <token>token</token>
            <sid>sid</sid>
            <site>site</site>
            <ext_map>ext_map</ext_map>
            <show_login_id>show_login_id</show_login_id>
            <display_nick>display_nick</display_nick>
            <taobao_nick>taobao_nick</taobao_nick>
            <sso_token>sso_token</sso_token>
            <alipay_account_no>alipayAccountNo</alipay_account_no>
        </return_value>
        <success>success</success>
    </result>
</alibaba_account_ssotoken_info_response>

{
    "alibaba_account_ssotoken_info_response":{
        "result":{
            "action_type":"action_type",
            "code":code,
            "code_group":"code_group",
            "message":"message",
            "msg_code":"msg_code",
            "msg_info":"msg_info",
            "return_value":{
                "hid":1000,
                "data":"data",
                "token":"token",
                "sid":"sid",
                "site":"site",
                "ext_map":"ext_map",
                "show_login_id":"show_login_id",
                "display_nick":"display_nick",
                "taobao_nick":"taobao_nick",
                "sso_token":"sso_token",
                "alipay_account_no":"alipayAccountNo"
            },
            "success":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.account.ssotoken.info (二方授权解ssoToken信息接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ