阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
identify_auth_dto	IdentifyAuthDTO	可选			鉴权结果DTO
└ auth_type_enum String 必须 CONTROLLER_SINGLE_VOUCHER 指定鉴权类型 └ properties_json String 必须 {} 属性json voucher_list VoucherDTO [] 必须 [] [] └ voucher_no String 必须 0092027340 卡号 └ voucher_type_enum String 必须类型枚举 xxx └ app_code String 必须 08988 应用code └ device_id String 必须 xxxx 子设备ID └ time_stamp Number 必须 12221 时间戳 └ sign String 必须 xx 签名

名称	类型	示例值	描述
result	PojoResult		结果
content IdentifyAuthResultDto 内容 └ biz_code String 123 业务id └ error_code String SUCCESS/PERMISSION_DENIED 鉴权结果码 └ error_msg String 请通过/抱歉，没有权限鉴权结果消息 user UserDTO 用户信息 └ user_id String 1873872 用户自定义ID └ company_id Number 1000 公司ID └ name String name name └ error_code String 200 错误码 └ error_msg String success 接口请求响应码 └ success Boolean true 接口是否请求成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaGuardAccessAuthRequest req = new AlibabaGuardAccessAuthRequest();
AlibabaGuardAccessAuthRequest.IdentifyAuthDTO obj1 = new AlibabaGuardAccessAuthRequest.IdentifyAuthDTO();
obj1.setAuthTypeEnum("CONTROLLER_SINGLE_VOUCHER");
obj1.setPropertiesJson("{}");
List<AlibabaGuardAccessAuthRequest.VoucherDTO> list3 = new ArrayList<AlibabaGuardAccessAuthRequest.VoucherDTO>();
AlibabaGuardAccessAuthRequest.VoucherDTO obj4 = new AlibabaGuardAccessAuthRequest.VoucherDTO();
list3.add(obj4);
obj4.setVoucherNo("0092027340");
obj4.setVoucherTypeEnum("类型枚举");
obj1.setVoucherList(list3);
obj1.setAppCode("08988");
obj1.setDeviceId("xxxx");
obj1.setTimeStamp(12221L);
obj1.setSign("xx");
req.setIdentifyAuthDto(obj1);
AlibabaGuardAccessAuthResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaGuardAccessAuthRequest req = new AlibabaGuardAccessAuthRequest();
AlibabaGuardAccessAuthRequest.IdentifyAuthDTODomain obj1 = new AlibabaGuardAccessAuthRequest.IdentifyAuthDTODomain();
obj1.AuthTypeEnum = "CONTROLLER_SINGLE_VOUCHER";
obj1.PropertiesJson = "{}";
List<AlibabaGuardAccessAuthRequest.VoucherDTODomain> list3 = new List<AlibabaGuardAccessAuthRequest.VoucherDTODomain>();
AlibabaGuardAccessAuthRequest.VoucherDTODomain obj4 = new AlibabaGuardAccessAuthRequest.VoucherDTODomain();
list3.Add(obj4);
obj4.VoucherNo = "0092027340";
obj4.VoucherTypeEnum = "类型枚举";
obj1.VoucherList= list3;
obj1.AppCode = "08988";
obj1.DeviceId = "xxxx";
obj1.TimeStamp = 12221L;
obj1.Sign = "xx";
req.IdentifyAuthDto_ = obj1;
AlibabaGuardAccessAuthResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaGuardAccessAuthRequest;
$identify_auth_dto = new IdentifyAuthDTO;
$identify_auth_dto->auth_type_enum="CONTROLLER_SINGLE_VOUCHER";
$identify_auth_dto->properties_json="{}";
$voucher_list = new VoucherDTO;
$voucher_list->voucher_no="0092027340";
$voucher_list->voucher_type_enum="类型枚举";
$identify_auth_dto->voucher_list = $voucher_list;
$identify_auth_dto->app_code="08988";
$identify_auth_dto->device_id="xxxx";
$identify_auth_dto->time_stamp="12221";
$identify_auth_dto->sign="xx";
$req->setIdentifyAuthDto(json_encode($identify_auth_dto));
$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.guard.access.auth' \
-d 'partner_id=apidoc' \
-d 'sign=857BFAD10A4613D3B4330235088EECB1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-25+20%3A32%3A37' \
-d 'v=2.0' \
-d 'identify_auth_dto=null'

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

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

req.identify_auth_dto="数据结构示例JSON格式"
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.guard.access.auth");
add_param(pRequest,"identify_auth_dto","数据结构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.guard.access.auth', {
	'identify_auth_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_guard_access_auth_response>
    <result>
        <content>
            <biz_code>123</biz_code>
            <error_code>SUCCESS/PERMISSION_DENIED</error_code>
            <error_msg>请通过/抱歉，没有权限</error_msg>
            <user>
                <user_id>1873872</user_id>
                <company_id>1000</company_id>
                <name>name</name>
            </user>
        </content>
        <error_code>200</error_code>
        <error_msg>success</error_msg>
        <success>true</success>
    </result>
</alibaba_guard_access_auth_response>

{
    "alibaba_guard_access_auth_response":{
        "result":{
            "content":{
                "biz_code":"123",
                "error_code":"SUCCESS\/PERMISSION_DENIED",
                "error_msg":"请通过\/抱歉，没有权限",
                "user":{
                    "user_id":"1873872",
                    "company_id":1000,
                    "name":"name"
                }
            },
            "error_code":"200",
            "error_msg":"success",
            "success":true
        }
    }
}

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.guard.access.auth (鉴权)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈