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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
availability_query	AvailabilityQuery	必须			查询条件
└ check_in String 必须 2023-01-01 yyyy-MM-dd └ children Number 可选 0 儿童人数 └ adults Number 必须 2 成人人数 └ language String 必须 zh_CN 标准语言ISO_639-1 二字码；例如：zh_CN,en_US └ hotel_id String 必须 654300 酒店ID └ check_out String 必须 2023-01-02 yyyy-MM-dd └ children_ages String [] 可选 [1] 每个儿童年龄，数组个数与儿童数相同 └ distributor String 可选 DIDAJL 分销渠道标识-由飞猪运营同学提供

名称	类型	示例值	描述
trace_id	String	0bbb10bf17025337270113592eb09f	traceId
data	Ari		data
└ language String en 标准语言ISO_639-1 二字码；例如：cn,en └ time Number 1702533728719 13位时间戳 properties HotelRate [] 价库-酒店价格列表 rates AriRate [] 价库-酒店下Rate列表 └ rate_key String 10183372001007-8650196001007-2040412339007-55104001-717746504680 rateKey cancel_policy AriCancellationPolicy 取消政策 └ code String 1 code └ cancellation_desc String xxx 取消政策描述 rules DateDetailRule [] 取消规则明细 └ onward String 2023-12-14 14:02:07 政策开始时间 └ before String 2023-12-15 00:00:00 政策截止时间 └ inclusive_amount String 0 取消政策-含税费罚金(单位：分) └ currency String CNY 币种 └ check_in_time String 14:00 checkInTime └ remark String xxxx 入住提醒 └ room_id String 87301001 房型ID └ room_name String 城景双床房房型名称 total_rate AriRateTotalRate 总价 └ inclusive String 2000 含税费金额(单位：分) └ fees String 0 费用金额(单位：分) └ exclusive String 2000 不包含税费金额(单位：分) └ tax String 0 税费金额(单位：分) └ currency String CNY 币种 └ check_in String 2023-12-14 checkIn └ check_out_time String 12:00 checkOutTime └ rate_plan_name String 20230804183409829测试rp RPName └ check_out String 2023-12-15 checkOut daily_rates AriRateDailyRate [] 日历价 └ date String 2023-12-14 日期 └ inclusive String 1000 含税费金额(单位：分) └ fees String 0 费用金额(单位：分) └ exclusive String 1000 不包含税费金额(单位：分) └ tax String 0 税费金额(单位：分) └ currency String CNY 币种 meals AriMealDTO 餐食信息 └ number Number 2 参数分数 └ type Number 1 餐食类型 0：无餐，1：含早餐，2：含两餐，3：含三餐 └ hotel_id String 55104001 酒店ID └ hotel_name String xxxx 酒店名称 └ request_trace_id String 12345 定价策略key，与每次返回结果对应 └ search_id String 12345 本次询价的标识，用于排查问题

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XhotelDistributionAriAvailabilityRequest req = new XhotelDistributionAriAvailabilityRequest();
XhotelDistributionAriAvailabilityRequest.AvailabilityQuery obj1 = new XhotelDistributionAriAvailabilityRequest.AvailabilityQuery();
obj1.setCheckIn("2023-01-01");
obj1.setChildren(0L);
obj1.setAdults(2L);
obj1.setLanguage("zh_CN");
obj1.setHotelId("654300");
obj1.setCheckOut("2023-01-02");
obj1.setChildrenAges("1");
obj1.setDistributor("DIDAJL");
req.setAvailabilityQuery(obj1);
XhotelDistributionAriAvailabilityResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XhotelDistributionAriAvailabilityRequest req = new XhotelDistributionAriAvailabilityRequest();
XhotelDistributionAriAvailabilityRequest.AvailabilityQueryDomain obj1 = new XhotelDistributionAriAvailabilityRequest.AvailabilityQueryDomain();
obj1.CheckIn = "2023-01-01";
obj1.Children = 0L;
obj1.Adults = 2L;
obj1.Language = "zh_CN";
obj1.HotelId = "654300";
obj1.CheckOut = "2023-01-02";
obj1.ChildrenAges = "1";
obj1.Distributor = "DIDAJL";
req.AvailabilityQuery_ = obj1;
XhotelDistributionAriAvailabilityResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XhotelDistributionAriAvailabilityRequest;
$availability_query = new AvailabilityQuery;
$availability_query->check_in="2023-01-01";
$availability_query->children="0";
$availability_query->adults="2";
$availability_query->language="zh_CN";
$availability_query->hotel_id="654300";
$availability_query->check_out="2023-01-02";
$availability_query->children_ages="[1]";
$availability_query->distributor="DIDAJL";
$req->setAvailabilityQuery(json_encode($availability_query));
$resp = $c->execute($req, $sessionKey);

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.xhotel.distribution.ari.availability' \
-d 'partner_id=apidoc' \
-d 'session=af40407a-4d61-40c8-ace5-0f868709737e' \
-d 'sign=FA83F667E9353B9CB5E76FD8CDBB36A2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-06+18%3A42%3A06' \
-d 'v=2.0' \
-d 'availability_query=null'

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

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

req.availability_query="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.xhotel.distribution.ari.availability");
add_param(pRequest,"availability_query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.xhotel.distribution.ari.availability', {
	'availability_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xhotel_distribution_ari_availability_response>
    <trace_id>0bbb10bf17025337270113592eb09f</trace_id>
    <data>
        <language>en</language>
        <time>1702533728719</time>
        <properties>
            <hotel_rate>
                <rates>
                    <ari_rate>
                        <rate_key>10183372001007-8650196001007-2040412339007-55104001-717746504680</rate_key>
                        <cancel_policy>
                            <code>1</code>
                            <cancellation_desc>xxx</cancellation_desc>
                            <rules>
                                <date_detail_rule>
                                    <onward>2023-12-14 14:02:07</onward>
                                    <before>2023-12-15 00:00:00</before>
                                    <inclusive_amount>0</inclusive_amount>
                                    <currency>CNY</currency>
                                </date_detail_rule>
                            </rules>
                        </cancel_policy>
                        <check_in_time>14:00</check_in_time>
                        <remark>xxxx</remark>
                        <room_id>87301001</room_id>
                        <room_name>城景双床房</room_name>
                        <total_rate>
                            <inclusive>2000</inclusive>
                            <fees>0</fees>
                            <exclusive>2000</exclusive>
                            <tax>0</tax>
                            <currency>CNY</currency>
                        </total_rate>
                        <check_in>2023-12-14</check_in>
                        <check_out_time>12:00</check_out_time>
                        <rate_plan_name>20230804183409829测试rp</rate_plan_name>
                        <check_out>2023-12-15</check_out>
                        <daily_rates>
                            <ari_rate_daily_rate>
                                <date>2023-12-14</date>
                                <inclusive>1000</inclusive>
                                <fees>0</fees>
                                <exclusive>1000</exclusive>
                                <tax>0</tax>
                                <currency>CNY</currency>
                            </ari_rate_daily_rate>
                        </daily_rates>
                        <meals>
                            <number>2</number>
                            <type>1</type>
                        </meals>
                    </ari_rate>
                </rates>
                <hotel_id>55104001</hotel_id>
                <hotel_name>xxxx</hotel_name>
            </hotel_rate>
        </properties>
        <request_trace_id>12345</request_trace_id>
        <search_id>12345</search_id>
    </data>
</xhotel_distribution_ari_availability_response>

{
    "xhotel_distribution_ari_availability_response":{
        "trace_id":"0bbb10bf17025337270113592eb09f",
        "data":{
            "language":"en",
            "time":1702533728719,
            "properties":{
                "hotel_rate":[
                    {
                        "rates":{
                            "ari_rate":[
                                {
                                    "rate_key":"10183372001007-8650196001007-2040412339007-55104001-717746504680",
                                    "cancel_policy":{
                                        "code":"1",
                                        "cancellation_desc":"xxx",
                                        "rules":{
                                            "date_detail_rule":[
                                                {
                                                    "onward":"2023-12-14 14:02:07",
                                                    "before":"2023-12-15 00:00:00",
                                                    "inclusive_amount":"0",
                                                    "currency":"CNY"
                                                }
                                            ]
                                        }
                                    },
                                    "check_in_time":"14:00",
                                    "remark":"xxxx",
                                    "room_id":"87301001",
                                    "room_name":"城景双床房",
                                    "total_rate":{
                                        "inclusive":"2000",
                                        "fees":"0",
                                        "exclusive":"2000",
                                        "tax":"0",
                                        "currency":"CNY"
                                    },
                                    "check_in":"2023-12-14",
                                    "check_out_time":"12:00",
                                    "rate_plan_name":"20230804183409829测试rp",
                                    "check_out":"2023-12-15",
                                    "daily_rates":{
                                        "ari_rate_daily_rate":[
                                            {
                                                "date":"2023-12-14",
                                                "inclusive":"1000",
                                                "fees":"0",
                                                "exclusive":"1000",
                                                "tax":"0",
                                                "currency":"CNY"
                                            }
                                        ]
                                    },
                                    "meals":{
                                        "number":2,
                                        "type":1
                                    }
                                }
                            ]
                        },
                        "hotel_id":"55104001",
                        "hotel_name":"xxxx"
                    }
                ]
            },
            "request_trace_id":"12345",
            "search_id":"12345"
        }
    }
}

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.xhotel.distribution.ari.availability (飞猪酒店分销-ARI-availability)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈