网站对接规范.docx
- 文档编号:9976320
- 上传时间:2023-02-07
- 格式:DOCX
- 页数:46
- 大小:31.38KB
网站对接规范.docx
《网站对接规范.docx》由会员分享,可在线阅读,更多相关《网站对接规范.docx(46页珍藏版)》请在冰豆网上搜索。
网站对接规范
网站对接规范
目录
网站对接规范1
1.文档目的2
2.对接数据规范3
2.1用户注册3
2.2用户登录3
2.3用户信息4
2.4酒店信息6
2.5房源信息11
2.5.1房管通推送房源信息11
2.5.2房管通拉取房源信息16
2.6房价设置16
2.6.1平日价设置17
2.6.2周末价设置17
2.6.3特殊时段价设置18
2.6.4周价设置19
2.6.5月价设置19
2.7规则设置20
2.8房态设置21
2.9订单信息22
2.9.1房管通拉取订单22
2.9.2合作网站推送订单23
2.9.3房管通推送订单25
3.技术规范26
3.1接口签名验证26
3.2技术部分二26
4.补充说明27
1.文档目的
本文档描述了房管通网站(以下简称“房管通”)与建立对接合作的各大商旅住宿OTA网站(以下简称“合作网站”)开展业务合作时,针对技术上所需实现的网站平台对接,合作双方需要遵循和参考的接口数据要求和接口调用规范。
业务对接涵盖内容如下:
●用户注册
●用户登录
●用户信息
●酒店信息
●房间信息
●房价设置,包括:
平日价设置、周末价设置、特殊时段价设置、周价设置、月价设置
●规则设置
●房态设置
●订单信息
2.对接数据规范
下文根据业务对接内容,具体描述对接数据规格。
1
2
2.1用户注册
业务描述:
◆新酒店商家在房管通可以直接注册合作网站的酒店账号,通过这样的方式也同时增加了合作网站的加盟酒店。
◆该业务要求房管通向合作网站推送用户注册的信息,合作网站根据房管通提供的用户注册信息返回该新账号在本网站注册的处理结果
数据规范:
◆房管通推送数据的规格如下:
参数名
参数类型
备注
user_login_name
字符型
用户注册账户名
user_password
字符型
用户注册账户密码
◆合作网站返回的处理结果数据的规格如下:
参数名
参数类型
备注
status
整型
1:
处理成功,0值表示处理不成功
msg
字符型
提示信息
data
(对象类型)
数据结果(可以为空)
备注补充:
◆合作网站预先提供关于本网站用户注册的规则信息,例如:
用户名长度要求、用户名是否可以包含空格和汉字、密码最低长度要求等
2.2用户登录
业务描述:
◆新店家用户使用合作网站的账号,通过房管通系统提供的登录功能,登录到合作网站上(后续操作,店家用户将通过使用该登录账号,维护其在合作网站上的房态、房价、房源等信息)
◆该业务要求房管通向合作网站推送用户登录的信息,合作网站根据房管通提供的用户登录信息返回该店家用登录的处理结果
数据规范:
◆房管通推送数据的规格如下:
参数名
参数类型
备注
user_login_name
字符型
用户账户名
user_password
字符型
用户账户密码
◆合作网站返回的处理结果数据的规格如下:
参数名
参数类型
备注
status
整型
1:
处理成功,0值表示处理不成功
msg
字符型
提示信息
data
(对象类型)
数据结果(可以为空)
备注补充:
◆
2.3用户信息
业务描述:
◆店家用户在房管通维护其用户信息(包括基本信息、详细信息、账户信息等)
◆该业务要求房管通向合作网站推送店家用户信息(包括新增和更新),房管通向合作网站推送店家用户的资料信息
◆合作网站根据其数据需求,解析和保存用户信息,并返回处理结果
数据规范:
◆房管通推送数据的规格如下:
参数名
参数类型
备注
user_login_name
字符型
合作网站上的用户登录名
user_nickname
字符型
昵称
user_surname
字符型
姓氏
user_name
字符型
名
user_gender
整型
性别。
0:
女,1:
男
user_cellphone
字符型
手机号码
user_cellphone_for_message
字符型
用户接收短信的手机号码
user_tele_area
字符型
电话区号
user_telephone
字符型
座机号码(如无座机,则可以是手机号码)
user_ext_telephone
字符型
座机分机号
user_fax_area
字符型
传真区号
user_fax
字符型
传真号码
user_email
字符型
电子邮箱
user_qq
字符型
用户QQ号码
user_msn
字符型
用户MSN
user_picture
字符型
用户头像图片网址链接
user_birth_year
整型
出生年份
user_birth_month
整型
出生月份
user_birth_day
整型
出生日期
user_school
字符型
用户毕业院校
user_province
字符型
用户所在省
user_city
字符型
用户所在市
user_address
字符型
用户住址
user_add_phone1
字符型
备用电话1
user_add_phone2
字符型
备用电话2
user_license
字符型
店家营业执照号码
user_license_picture
字符型
店家营业执照扫描图片网址链接
user_idnumber
字符型
身份证号码
user_idcard_picture
字符型
身份证扫描图片网址链接
user_selfdescription
字符型
自我介绍
user_finance_name
字符型
酒店财务联系人
user_finance_telephone
字符型
酒店财务联系人手机
user_finance_mail
字符型
酒店财务联系人邮箱
user_accountlist
(集合)
用户设置的结算账户列表(允许多个账户)。
每一个结算账户的数据规格见下表。
⏹结算账户的数据规格如下:
参数名
参数类型
备注
account_state
整型
若用户有多个结算账户,则该参数标识是否为默认账户:
0否,1是。
若只有一个结算账户,则该账户为默认账户,取值1。
account_type
整型
账户类型:
1:
支付宝,2:
财付通,3:
银行账户
account_num
字符型
账户账号
account_name
字符型
账户姓名
bank_name
字符型
开户行银行名称。
非银行账户该参数为空
bank_province
字符型
开户行所在省。
非银行账户该参数为空
bank_city
字符型
开户行所在市。
非银行账户该参数为空
bank_subbranch
字符型
开户行所属支行。
非银行账户该参数为空
bank_type
整型
银行账户类型:
0个人账户,1企业账户。
非银行账户该参数为空
◆合作网站返回的处理结果数据的规格如下:
参数名
参数类型
备注
status
整型
1:
处理成功,0值表示处理不成功
msg
字符型
提示信息
data
(对象类型)
数据结果(可以为空)
备注补充:
◆对于用户信息,上述数据规范提供了基础参考。
若合作网站对信息内容有特殊要求可以另行提出,例如:
对于某些信息,合作网站要求用户必填或某些信息的字符长度最大或者最小限制。
对于特殊数据规格的要求,合作双方另行协商约定在哪一方控制和处理。
2.4酒店信息
业务描述:
◆店家用户在房管通系统维护其在房管通上的酒店信息
◆该业务要求房管通向合作网站推送店家的酒店信息(包括新增和更新)
◆合作网站根据其数据需求,解析和保存该用户的酒店信息,并返回处理结果
数据规范:
◆房管通推送数据的规格如下:
参数名
参数类型
备注
user_login_name
字符型
合作网站上的用户登录名
hotel_id
字符型
合作网站该酒店ID。
房管通首次推送时该ID为空,合作网站上根据推送信息新增该酒店信息时,需要将ID包含在返回结果中;后续房管通更新酒店信息并推送至合作网站是提供该ID。
hotel_name
字符型
酒店名称
hotel_type1
字符型
酒店类别(文字描述,需要双方协商类别名称规范,房管通提供的参考规范详见备注)
hotel_type2
字符型
酒店子类别(文字描述,需要双方协商类别名称规范,房管通提供的参考规范详见备注)
hotel_telephone_area
字符型
前台号码区号
hotel_telephone
字符型
前台号码
hotel_introduction
字符型
酒店简介
hotel_setup_year
整型
开业年份
hotel_decorate_year
整型
装修年份
hotel_announcement
字符型
一句话广告
hotel_tags
字符型
特色标签。
多个标签时采用CSV格式表示,
例如:
“古色古香,田园风光,古镇风情”
hotel_province
字符型
所在省
hotel_city
字符型
所在市
hotel_region
字符型
所在区
hotel_biotope
字符型
小区/地名
hotel_address
字符型
详细地址
hotel_longitude
数值型
地图经度
hotel_dimension
数值型
地图纬度
hotel_awayfrom_airport
整型
与机场的距离(公里)
hotel_airport_traffic
字符型
到机场的交通信息描述
hotel_awayfrom_train
整型
离火车站距离(公里)
hotel_train_traffic
字符型
到火车站的交通信息描述
hotel_awayfrom_bus
整型
离汽车站的距离(公里)
hotel_bus_traffic
字符型
到汽车站的交通信息描述
hotel_awayfrom_wharf
整型
到离码头的距离(公里)
hotel_wharf_traffic
字符型
到码头的交通信息描述
hotel_other_traffic
字符型
其他交通信息描述
hotel_landmark
字符型
附近地标。
多个地标以CSV格式表示,
例如:
“杭州六公园,杭州城战火车站,南山路”
hotel_scenicspot_and_tradingarea
字符型
景点/商区。
多个景点/商区以CSV格式表示,例如:
“西湖景区,柳浪闻莺,河坊街,武林商业街”
hotel_surrounding_service
字符型
周边配套服务。
多个配套服务以CSV格式表示,例如:
“公交车站,西湖码头,花鸟市场,吴山美食街”
hotel_facility_service
(对象类型)
酒店设施服务包含多个服务项目,以嵌套对象类型的形式描述。
详见下文关于该对象数据规格的说明。
hotel_other_service
字符型
其它服务说明
hotel_invoice
整型
是否可开发票,-1不提供,0免费,>0,收费(%)
hotel_foreign_guests
整型
是否接待外宾,1接待,0不接待
hotel_need_identity_card
整型
入住是否需要身份证。
1需要,0不需要
hotel_checkin_time
整型
入住时间(取0至24之间的整数,24小时制)
hotel_checkout_time
整型
退房时间(取0至24之间的整数,24小时制)
hotel_save_time
整型
最晚保留时间(取0至24之间的整数,24小时制)
hotel_business_hours_begin
整型
营业开始时间(例如:
6点;取0至24之间的整数,24小时制)
hotel_business_hours_end
整型
营业结束时间(例如:
22点;取0至24之间的整数,24小时制)
hotel_can_swiping
整型
是否可以刷卡:
1可以0不可以
hotel_credit_card_support
字符型
支持的信用卡种类。
多个种类以CSV格式表示,例如:
“国内银联卡,国际信用卡万事达(Master),国际信用卡威士(VISA)”
hotel_other_require
字符型
其它要求
hotel_other_declare
字符型
其它补充说明
hotel_picturelist
(集合类型)
酒店图片集。
同一家酒店可以有多条酒店图片信息。
每一条酒店图片信息的数据规格如下表所述。
⏹酒店图片信息的数据规格如下:
参数名
参数类型
备注
hotelinfo_picture_type
整型
图片类别:
1:
外观;2:
大厅;3:
公共区域;4:
周边环境;5:
餐厅;6:
娱乐设施;7:
客栈印象图片;8:
其它
hotelinfo_picture_path
字符型
图片的网址链接
hotelinfo_picture_describe
字符型
图片描述
⏹酒店设施服务的项目描述,数据规格如下:
参数名
参数类型
备注
kongtiao
整型
空调。
-1不提供,1提供
nuanqi
整型
暖气。
-1不提供,1提供
wifi
整型
免费wifi。
-1不提供,1提供
kuandai
字符型
宽带上网。
空字符串表示不提供,非空字符串时取字符串字面含义。
非空字符串的枚举值有:
免费、收费、无、不确定、部分收费、部分房间有且免费、部分房间有且收费、部分房间有且部分免费。
reshui
整型
24小时热水。
-1不提供,1提供
wzaiss
整型
无障碍设施。
-1不提供,1提供
djjmj
整型
对讲机门禁。
-1不提供,1提供
beidangh
字符型
被单更换。
空字符串表示不提供,非空字符串按字面意义解释,枚举值包括:
每日一更、每客一更、每周一更。
dzks
整型
电子卡锁。
-1不提供,1提供
dianti
整型
电梯。
-1不提供,1提供
baoan
整型
保安。
-1不提供,1提供
swzx
整型
商务中心。
-1不提供,1提供
yhkxyk
整型
接受银行卡/信用卡。
-1不支持,1支持
hyzx
整型
会议中心。
-1不提供,1提供
tingchewei
整型
停车位。
-1不提供,非负数值表示停车计费(计费单位:
元/天)
czdy
整型
传真打印。
-1不提供,1提供
jxfw
整型
叫醒服务。
-1不提供,1提供
zsct
整型
中式餐厅。
-1不提供,1提供
xsct
整型
西式餐厅。
-1不提供,1提供
zzcf
整型
自助厨房。
-1不提供,1提供
zzsk
整型
自助烧烤。
-1不提供,1提供
mfpc
整型
免费品茶。
-1不提供,1提供
mfcs
整型
免费茶水。
-1不提供,1提供
mfsg
整型
免费水果。
-1不提供,1提供
mflyzx
整型
免费旅游咨询。
-1不提供,1提供
zxczl
整型
自行车租赁。
-1不提供,1提供
bczcfw
整型
包车/租车服务。
-1不提供,1提供
dyfw
整型
导游服务。
-1不提供,非负数值表示导游计费(计费单位:
元/天)
dsmp
整型
代售门票。
-1不提供,1提供
dscp
整型
代售车票。
-1不提供,1提供
djmxp
整型
代寄明信片。
-1不提供,1提供
jzfw
整型
接站服务。
-1不提供,非负数值表示服务计费(计费单位:
元/次)
xxq
整型
休闲区。
-1不提供,1提供
gpkl
整型
光盘刻录。
-1不提供,1提供
ddtc
整型
代售当地特产。
-1不提供,1提供
jjfw
整型
接机服务。
-1不提供,非负数值表示服务计费(计费单位:
元/次)
xljc
整型
行李寄存。
-1不提供,非负数值表示服务计费(计费单位:
元/天)
cyyp
整型
提供常用药品。
-1不提供,1提供
xhkh
整型
小孩看护。
-1不提供,1提供
jdjtxh
整型
可接待家庭/小孩。
-1不接待,1可接待
chaoshi
整型
超市。
-1没有,1有
kdcw
整型
可带宠物。
-1不允许,1允许
xiyan
整型
可以吸烟。
-1不允许,1允许
xyffw
整型
洗衣房/服务。
-1不提供,1提供
zzxy
整型
自助洗衣。
-1不提供,1提供
yinghan
整型
银行。
-1没有,1有
hxjg
整型
海鲜加工。
-1不提供,1提供
wangba
整型
网吧。
-1不提供,1提供
minidyy
整型
迷你电影院。
-1不提供,1提供
sgcz
整型
水果采摘。
-1不提供,1提供
jianshefang
字符型
健身房。
字符串为空表示不提供;字符串非空则按照“[单价],[计价单位]”格式提供,例如:
“30,小时”表示30元一小时,“90,次”表示90元入场一次。
jiuba
整型
酒吧。
-1不提供,1提供
qipai
整型
棋牌。
-1不提供,1提供
zhuoyou
整型
桌游。
-1不提供,1提供
zdmjz
整型
自动麻将桌。
-1不提供,1提供
mfskyd
整型
免费书刊阅读。
-1不提供,1提供
dyyl
整型
电影阅览。
-1不提供,1提供
chuidiao
整型
垂钓。
-1不提供,1提供
jbhd
字符型
是否适合举办活动。
空字符串表示不适合;字符串非空则按照“[单价],[计价单位]”格式提供,例如:
“900,天”表示900元一天,“1500,次”表示1500元举办一次。
sanna
整型
桑拿。
-1不提供,1提供
wenquan
整型
温泉。
-1不提供,1提供
spa
整型
SPA。
-1不提供,1提供
snyyc
整型
室内游泳池。
-1不提供,非负数值表示使用计费(计费单位:
元/次)
swyyc
整型
室外游泳池。
-1不提供,非负数值表示使用计费(计费单位:
元/次)
◆合作网站返回的处理结果数据的规格如下:
参数名
参数类型
备注
status
整型
1:
处理成功,0值表示处理不成功
msg
字符型
提示信息
data
字符型
返回合作网站上该酒店的ID号。
备注补充:
◆酒店类别和子类别划分的规范如下所示,其中黑体字代表父类别,斜体字代表子类别(例如:
“酒店宾馆”、“旅馆客栈”是父类别,“经济型酒店”是酒店宾馆的子类别,“特色客栈”是旅馆客栈的子类别)。
合作网站参考如下内容,根据其实际情形作解析以及与本网站自有的类别设置作对应。
酒店宾馆:
五星级
四星级
三星级
经济型酒店
商务型酒店
会展会务酒店
顶级豪华酒店
主题酒店
度假休闲酒店
精品酒店
宾馆
招待所
旅馆客栈:
青年旅舍
国际青年旅舍
特色客栈
家庭旅馆
农家乐
四合院
短租公寓:
酒店式公寓
家庭式公寓
豪宅
集体宿舍
阁楼
度假村:
度假村
其它:
独栋别墅
林间小屋
城堡
树屋
船舱
房车
冰屋
海边小屋
活动场地
会议室
会所
其它
2.5房源信息
2.5.1房管通推送房源信息
业务描述:
◆店家用户在房管通系统维护其在房管通上的房型信息
◆该业务要求房管通向合作网站推送店家的房型信息
◆合作网站根据其数据需求,解析和保存该用户的房型信息,并返回处理结果
数据规范:
◆房管通推送数据的规格如下:
参数名
参数类型
备注
user_login_name
字符型
合作网站上的用户登录名
roomclass_list
(集合类型)
房型集合。
多条房型数据的集合,针对每一条房型数据,详细的数据规格见下文。
⏹房型的数据规格如下:
参数名
参数类型
备注
roomclass_fgt_id
整型
该房型在房管通系统中的唯一ID标识
roomclass_name
字符型
房型名称
roomclass_title
字符型
房型标题
roomclass_feature
字符型
房间特色
roomclass_introductions
字符型
房型简介
roomclass_quantity
整型
房管通第一次推送房源信息时,该数值对应的是该房型店家所拥有的房间数量。
第一次推送之后,房管通获取合作网站上对应于该房型的ID并在房管通中建立房型关联。
房管通后续维护这种关联关系,并在后续的房源信息推送中根据关联对应的关系推送相应房型的留房数量。
roomclass_dailyprice
整型
一日价。
第一次推送时是该房型价格的初始值。
后续推送时根据房管通房型关联推送的价格更新值。
roomclass_weekendprice
整型
周末价。
第一次推送时是该房型价格的初始值。
后续推送时根据房管通房型关联推送的价格更新值。
roomclass_weekprice
整型
一周价。
第一次推送时是该房型价格的初始值。
后续推送时根据房管通房型关联推送的价格更新值。
roomclass_monthlyprice
整型
一月价。
第一次推送时是该房型价格的初始值。
后续推送时根据房管通房型关联推送的价格更新值。
roomclass_deposit
整型
前台押金。
第一次推送时是该房型价格的初始值。
后续推送时根据房管通房型关联推送的价格更新值。
roomclass_lease_type
整型
出租方式。
0整套出租;1单间(非隔断);2单间(隔断);3床铺;4沙发
roomclass_capacity
整型
可住人数
roomclass_capacity_extend
整型
额外可加人数
roomclass_bedroom_num
整型
卧室数量
roomclass_parlour_num
整型
客厅数量
roomclass_kitchen_num
整型
厨房数量
roomclass_bathroom_num
整型
卫生间数量
roomclass_balcony_num
整型
阳台数量
roomclass_study_num
整型
书房数量
roomclass_bathroom_type
整型
卫生间类型。
0独立卫生间;1公共卫生间
roomclass_storey_num
整型
所在楼层是第几层
roomclass_storey_total
整型
总共楼层数
roomclass_orientations
整型
房屋朝向,1-8对应东、西、南、北、东南、东北、西南、西北
roomclass_room_area
整型
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 网站 对接 规范