青芒果网站联盟API平台集成开发指南模板Word格式.docx
《青芒果网站联盟API平台集成开发指南模板Word格式.docx》由会员分享，可在线阅读，更多相关《青芒果网站联盟API平台集成开发指南模板Word格式.docx（66页珍藏版）》请在冰豆网上搜索。
版本状态
作者
审核人
发布日期
备注
V1.0
2012-11
初稿
V1.1
2013-5
修改
方案概述
1.1目的
本文描述了网站联盟API平台对联盟伙伴提供的接口化预订解决方案，帮助联盟伙伴轻松实现酒店在线预订和查询功能。
1.2接口介绍
采用青芒果webAPI，请求分为Get及Post两种，应答为xml形式，返回编码类型统一为UTF-8。
请求参数分为必填和可选参数，参数如果有中文或特殊字符请UrlEncode（UTF-8）编码。
请求成功status节点返回1否则返回0。
注：
测试环境为：
***.com:
8181，请求查询参数字母一律为小写，如hotelid不是hotelId
基础数据
2.1城市查询
接口说明
城市列表查询
HTTP请求方式
Get
HTTP请求编码方式
UTF-8
接口地址
***.com/hotel/city?
<
必选参数>
|<
可选参数>
2.1.1查询参数
参数名
类型
必填
说明
agentid
String
Yes
联盟商家ID（由青芒果分配）
sign
数据签名值，参考附录【数据签名01】
2.1.2返回结果
节点名
父节点
status
root
Int
1表示请求成功，0为请求失败
message
请求成功时为successed，失败时为具体错误代码，参考附录【错误代码】
description
接口数据描述
list
XMLElement
城市列表数据，请求失败时，此节点为空，具体数据请参考查询示例
city
城市信息节点
id
XMLAttribute
城市ID
name
城市名称
pin-yin
城市拼音
suo-xie
城市缩写
code
城市代码
2.1.3查询示例
请求URL数据示例
agentid=10000&
sign=72f16abbc8a********b42949b4da26475
返回数据-查询成功
?
xmlversion='
1.0'
encoding='
utf-8'
?
>
root>
<
status>
1<
/status>
message>
successed<
/message>
description>
列出中国所有省份的二级城市<
/description>
list>
<
cityid="
2232"
name="
深圳"
pin-yin="
shenzhen"
suo-xie="
sz"
code=“HMI1”>
/city>
3231"
广州"
guangzhou"
suo-xie="
gz"
code=“HMI2”>
/list>
/root>
返回数据-查询失败
0<
exception<
列出中国所有省份及二级城市<
2.2区域查询
区域查询
***.com/hotel/area?
2.2.1查询参数
cityid
城市ID（请从城市接口获取）
2.2.2返回结果
区域列表数据，请求失败时，此节点为空，具体数据请参考查询示例
area
区域信息节点
区域ID
区域名
区域拼音
区域缩写
2.2.3查询示例
列出城市的区域<
areaid="
福田区"
>
/area>
areaid="
罗湖区"
2.3地标,商圈查询
地标查询（固定的类别有：
旅游景点，商业区/街区，高校/政府机构，会展中心/体育馆，医院）（商业区/街区表示商圈）
***.com/hotel/tag?
2.3.1查询参数
type
No
地标分类（1：
旅游景点，2：
商业区/街区，3：
高校/政府机构，4：
会展中心/体育馆，5：
医院）（不传默认所有地标）
2.3.2返回结果
地标列表数据，请求失败时，此节点为空，具体数据请参考查询示例
tag
地标信息父节点
地标ID
地标名称
2.3.3查询示例
sign=72f16abbc8a********b42949b4da26475&
cityid=1
xmlversion="
1.0"
encoding="
utf-8"
1
successed
列出城市的地标
tagid="
39779"
北京中医医院"
/>
39788"
北京协和医院"
列出城市的地标<
酒店数据
3.1酒店列表查询
酒店列表查询
***.com/hotel/list?
3.1.1查询参数
城市Id（不传参默认北京）
sdate
入住日期（要大于今天，不传参默认为明天）格式为yyyy-mm-dd
edate
离店日期（不传参默认为后天，离店日期要大于入住日期）格式为yyyy-mm-dd
keys
关键字（如有中文或特殊字符请UrlEncode（UTF-8）编码），如：
北京胡同这四个字的编码为：
%e5%8c%97%e4%ba%ac%e8%83%a1%e5%90%8c
类别（1：
酒店式公寓，2：
特色客栈，3：
家庭旅馆，4：
青年旅舍）
price
价格（1：
100元以下，2：
100-200元，3：
200-300元，4：
300元以上）
sort
排序数据（ddnums：
按销量降序，dpnums：
按点评降序，eprice：
按价格降序，eeprice：
按价格升序）
pageindex
当前页数（不传默认显示第一页）
pagesiz
升级会员 