中国航信酒店平台接口开发指南

中国航信酒店平台接口开发指南V1.0.1中国民航信息网络股份有限公司2010年6月变更记录DateVersionDescriptionAuthor2010/061.0.0版本发布杨同波2010/061.0.1概述中增加了业务建议；hotelBE接口参考文档扩展房健2011/041.0.2增加了对缓存接口的补充描述房健目录变更记录...................................................................................................................................21概述...............................................................................................................................................42开发步骤........................................................................................................................................52.1申请使用接口的帐号：.....................................................................................................52.2对酒店接口进行开发的步骤：.........................................................................................62.2.1阅读hotelbe接口文档,熟悉酒店的相关业务知识..............................................62.2.2设计本地表结构，缓存酒店的信息......................................................................62.2.3接收hotelce的酒店消息通知...............................................................................62.2.4查询通知消息.........................................................................................................73技术支持......................................................................................................................................124参考文档.....................................................................................................................................141概述对于需根据自己业务规则调整数据的渠道，需采用缓存数据+动态查询预订的机制。首先，静态信息（如城市列表、酒店名称、ID等内容）和动态信息（如价格、房态等信息）通过缓存数据接口定期获得（如每周定时获取一次，更新到渠道本地数据库中）；其次，查询实时价格和预订等通过HotelBE接口完成；最后，异步的变价等通知信息需渠道建立通知监听服务接收HotelCE通知消息。本文档描述了中航信平台酒店接口开发指南,内容涉及平台相关的多个系统。平台接口后台应用通过MQ服务提供，UTF-8编码格式。客户通过DirectLink统一访问地址，可以访问平台酒店的多个应用接口。每条指令都包括两部分：请求和返回，都有统一的XML格式，请求指令以OTRequest为根节点，返回指令以OTResponse为根节点。指令的具体格式请参照不同应用的相关接口文档。外网测试服务地址：生产服务地址：提交指令均以httpPost请求的方式，参数名为request，即将请求XML串放到request参数中。UTF-8编码格式。每个应用的接口指令通过其中的application元素区分该指令所要访问的平台应用，每条指令的application必须填写正确，否则请求的指令不能被相应的应用所处理，application区分大小写。本文涉及三个应用：hotelcache:缓存接口，提供给平台渠道缓存酒店数据。hotelbe：交易接口，提供给平台渠道查询预订酒店。hotelce：通知接口，提供给酒店发送相关信息给平台，同时平台会将酒店相关信息发给特定的渠道。另外，需要注意的是，由于业务可能会有扩展，在新接口的基础上会增加个别字段，而一些第三方插件在从xml到对象转换时，对新增加字段的解析有可能会出现问题，所以在开发时，对请求的返回结果的解析最好采用逐级逐节点的解析，尽量不要采用第三方插件把xml转换成对象，否则由此产生的问题，需要渠道端再次修改才能适用！2开发步骤您可以通过以下步骤使用中航信的酒店平台接口：2.1申请使用接口的帐号：您需要向分支申请使用接口，获得申请接口的认证信息。（1）申请成为TravelHub平台渠道航旅通的Office已经默认作为平台的渠道。渠道code等同于officeCode（2）申请接口认证信息申请认证信息需要说明：开通测试还是生产系统申请流程：航信各分支机构处填写酒店预订技术接口(hotelbe)申请单，分支机构业务负责人签字后发送传真至010-82861705，并发申请单电子版至[e-mail]。总部收到传真领导签字审核通过后三个工作日内开通接口，并将接口认证信息发送到申请单中的负责人邮箱。（3）认证信息的格式接口的认证信息放在指令的IdentityInfo元素中.如下：IdentityInfoOfficeID代理Office号/OfficeIDUserID用户名/UserIDPassword用户密码/PasswordRole角色/Role/IdentityInfo该认证信息要放在接口指令中，directLink会对每一条请求指令进行权限验证。2.2对酒店接口进行开发的步骤：2.2.1阅读hotelbe、数据缓存等接口文档,熟悉酒店的相关业务知识HotelBE是TravelHub平台面向下游渠道的实时交易接口，主要供渠道通过单酒店查询、预订等指令和平台就具体酒店动态数据、订单等信息进行交互。HotelBE接口技术文档中着重讲了指令的格式和调用方式，技术实现上相对简单。开发接口前了解指令中每个元素的含义，熟悉酒店预订相关的业务知识是非常必要的。参考文档:中国航信HotelBE数据缓存接口描述、调用HotelBE推荐方案、HotelBE接口文档2.2.2设计本地表结构，缓存酒店的信息由于酒店的信息量大，不仅包括酒店的静态信息，例如名称、地址、描述、电话、邮编、传真、行政区域、地标、房型描述等，而且包含动态信息，例如房型价格、配额、担保政策、预订政策等。因此接口客户必须对酒店的信息进行本地缓存，以提高客人的查询的速度和效率。客户需在熟悉业务的基础上，结合接口文档设计本地的表结构，缓存酒店的所有信息。本地化缓存后，客户可以自己本地设置酒店的促销级别，灵活地展现客人查询后酒店的展示顺序和必要的信息。利用HotelBE数据缓存接口中的酒店信息查询、酒店房价信息查询等指令（具体参考《中国航信HotelBE数据缓存接口描述》），客户可以把查到的酒店信息缓存在本地数据库中。2.2.3接收hotelce的酒店消息通知本地话缓存数据后，客人在客户网站的酒店查询操作都是查询本地的数据库。当酒店的信息发生变化时，酒店会发消息给平台，平台会给特定的渠道发送消息通知。客户在收到消息通知后，解析收到的XML，并对本地的数据进行更新。我们这里发送的形式是：渠道提供的消息接收地址?messageXML=……（消息XML串）&msgID=……（消息ID）例如：房型可用性通知：酒店可能会对关闭某些房型，或者上线销售新的房型。房价通知：酒店可能调整房型的价格。政策通知：酒店可能调整预订或者担保等政策。消息通知的类型和具体格式含义，请参照hotelce相关文档。2.2.4查询通知消息某些情况下，可能导致客户没有收到必要的信息，而导致本地数据没有及时更新，例如：客户的消息处理服务中断不可用网络原因导致消息丢失或者不可到达因此，客户可以调用指令查询某个时间段或符合一定条件的消息，由于消息的数量较大，我们可能对查询的条件进行限制，以减小对系统的压力，提高传输效率。代理可发送消息查询指令查询某个时间段的所有通知消息，这样可以避免有些消息没有收到导致的数据同步不一致的问题。代理通过发送httpPost请求，把查询的指令放到名为request的参数中。调用方法等同于调用HBE主动查询指令的方法。生产请求地址格式：=...测试请求地址：=...2.2.4.1通知消息ID查询指令通过该指令查询一段时间内的通知消息的ID示例：OTRequestTransactionNameQueryNotifyMsgIDRQ，固定值，必填/TransactionNameHeaderApplicationnotify，固定值，必填/Application/HeaderIdentityInfo接口认证信息OfficeIDoffice号/OfficeIDUserIDuserid/UserIDPasswordpassword/Password/IdentityInfoQueryNotifyMsgIDRQInfoBeginTime起始时间，YYYYMMDDTTMM，例如201006040800/BeginTimeEndTime终止时间，YYYYMMDDTTMM，例如201006042459/EndTimeMsgName消息名称/MsgNameMessageType/MessageType/QueryNotifyMsgIDRQInfo/OTRequest返回消息格式：OTResponseTransactionNameQueryNotifyMsgIDRS/TransactionNameHeader/IdentityInfo/Code20000/CodeDescriptionsuccess/DescriptionMsgInfosNumber=消息总数MsgId消息ID,可重复元素/MsgId/MsgIDInfos/OTResponseApplicationnotify/Application为必填项TransactionNameQueryNotifyMsgIDRS/TransactionName为必填项查询限制：起