1.引言
1.1.目的
1.2.读者对象
1.3.文档内部约定
1.3.1.文档字体约定
1.4.术语与缩写
2.方案概述
2.1.业务说明
2.2.业务流程
2.3.API2.0平台介绍
3.数据格式
3.1.请求地址
3.2.请求类型
3.3.测试及正式访问
3.3.1.测试环境访问
3.3.2.生产环境访问
3.4.请求频次
3.5.签名原始串
3.6.签名算法
3.6.1.MD5签名原理
3.7.接口介绍
3.7.1.用户 User
3.7.1.1.用户生成 OTA_UserUniqueID
3.7.2.酒店Hotel
3.7.2.1.静态文件下载
3.7.2.2.联通测试 OTA_Ping
3.7.2.3.酒店查询 OTA_HotelSearch
3.7.2.4.酒店静态信息查询 OTA_HotelDescriptiveInfo
3.7.2.5.价格计划查询 OTA_HotelRatePlan
3.7.2.6.价格缓存变化查询 OTA_HotelCacheChange
3.7.2.7.可订检查OTA_HotelAvail
3.7.2.8.订单生成 OTA_HotelRes
3.7.2.9.订单取消 OTA_Cancel
3.7.2.10.订单变化查询 OTA_HotelResNotif
3.7.2.11.订单详情查询 OTA_Read
3.7.2.12.酒店列表查询 D_HotelSearch
3.7.2.13.酒店详情 D_HotelDetail
3.7.2.14.酒店订单列表查询 D_HotelOrderList
3.7.2.15.酒店订单详情查询 D_HotelOrderDetail
3.7.2.16.酒店评价查询 D_HotelCommentList
3.7.3.国内机票Flight
3.7.3.1.静态文件下载
3.7.3.2.国内机票查询 OTA_FlightSearch
3.7.3.3.国内机票生成订单 OTA_FltSaveOrder
3.7.3.4.国内机票取消订单 OTA_FltCancelOrder
3.7.3.5.国内机票订单列表OTA_FltOrderList
3.7.3.6.国内机票订单详情 OTA_FltViewOrder
3.7.3.7.国内机票订单变更 OTA_GetStatusChangedOrders
3.7.4.国际机票Flight
3.7.4.1.静态文件下载
3.7.4.2.国际机票查询 OTA_IntlFlightSearch
3.7.4.3.机型信息查询OTA_FltGetCraftInfos
3.7.4.4.城市查询 OTA_FltGetCityInfos
3.7.4.5.机场查询 OTA_FltGetAirportInfos
3.7.4.6.航空公司信息 OTA_FltGetAirlineInfos
3.7.5.度假Vacations
3.7.5.1.度假地址选择器 OTA_VacationAddressSelector
3.7.5.2.度假城市列表(热门城市) OTA_VacationCity
3.7.5.3.度假证件类型 OTA_VacationCredentialType
3.7.5.4.度假配送方式 OTA_VacationDeliverType
3.7.5.5.度假酒店 OTA_VacationHotels
3.7.5.6.度假订单金额计算 OTA_VacationOrderAmount
3.7.5.7.度假临时订单生成 OTA_VacationOrderCreate
3.7.5.8.度假订单列表 OTA_VacationOrderList
3.7.5.9.度假订单明细 OTA_VacationOrderInfo
3.7.5.10.度假产品单选项 OTA_VacationOrderItem
3.7.5.11.产品查询列表 OTA_VacationPackageList
3.7.5.12.产品明细 OTA_VacationPackageInfo
3.7.5.13.度假暂存订单详情 OTA_VacationTmpOrderInfo
3.7.5.14.度假系统机票 OTA_VacationSysFlight
3.7.5.15.度假可选项列表 OTA_VacationOrderOption
3.7.6.支付
3.7.6.1.在线支付
3.7.6.2.支付流水查询 GetPaymentInfo
3.7.7.团购
3.7.7.1.团购产品列表查询GroupProductList
3.7.7.2.团购产品详细查看 GroupProductInfo
3.7.7.3.团购订单列表查询GroupOrderList
3.7.7.4.团购订单生成 GroupCreateOrder
3.7.7.5.团购券查询 GroupQueryTickets
3.7.7.6.团购订单通知 GroupOrderChange
3.7.7.7.团购产品通知 GroupProductChange
3.7.7.8.团购券通知 GroupTicketChange
3.7.7.9.团购券取消 GroupCancelTickets
4.附录
4.1.FAQ
4.1.1.问:我运行程序后怎么一直报错误代码:签名错误?
4.1.2.问:我怎么得到联盟身份(Alliance)和站点密钥(Secretkey)?
4.1.3.问:如果我只想使用酒店查询功能,然后跳转到CTRIP.com完成预订怎么办?
4.1.4.问:
4.1.11.问:我之前用的是酒店API1.0查询酒店信息的,请问现在提供的API2.0查询接口在使用方式上与AP
4.1.12.问:为什么我调用酒店API2.0的可订性检查接口会抛下面的错。
4.1.13.问:酒店API2.0新预订接口下单时,担保信息必须要填写吗?
4.1.14.问:酒店API2.0新预订接口对于信用担保时录入的信用卡资料需要经过加密再传入吗?
4.1.15.问:酒店API2.0搜索接口节点infot
4.1.16.问:酒店API2.0的搜索接口提供最低价格的显示吗?
4.1.17.问:酒店API2.0的搜索接口提供国外酒店的搜索吗?
4.1.18.问:酒店API2.0价格计划接口返回的内容中
携程网站联盟 APIAPI 平台平台 2.02.0
携程网站联盟
集成开发指南
集成开发指南
文件状态:
[] 草稿
[] 正在修改
[√ ] 正式发布
文档编号: P-11096.2-09-02
项 目 名: 网站联盟 II 期-API2.0 平台
作
者: 刘磊
文 件 名: 携程旅行网网站联盟 API2.0 集成开发指南.doc
保密等级:
审 核 人:
批 准 人:
最后更新时间: 2012-7-11
版权申明:
本文件属于机密文件,所有权属于携程计算机技术(上海)有限公司。任何接触此件的人必须
遵守以下规定:
1. 本文件及包含的内容均属于携程计算机技术(上海)有限公司资产。
2. 未经携程计算机技术(上海)有限公司的书面同意,任何人不得对本文件的全部和/或部
分内容进行任何形式的复制或传播扩散。
1
审核人
发布日期
备注
2012-5-4
2012-5-7 增加国际机票相关内容
刘磊
2012-5-8
刘磊
2012-5-10
2012-5-11
2012-6-4
刘磊
2012-6-11
刘磊
2012-7-11
1.修改酒店搜索,可订检查,
订单详情等契约及说明
2.更新错误代码
1.增加度假 API 说明
2.请求列表中删除订单提交
API
1.增加支付说明
2.增加静态文件下载地址
1.修改酒店静态信息接口说
明,修正请求样例中的错误
1.增加团购 API 相关说明
2.增加酒店 API 相关时间格
式说明
3.增加酒店 API 价格计划促
销活动说明
1.增加国内机票 API 说明
2.修正团购 API 请求类型说
明
1 . OTA_HotelSearch 和
OTA_HotelRatePlan 增加 7 天
及香格里拉等酒店查询参数
说明
版本历史
版本/状态
V0.1
V0.2
V0.3
V1.0
V1.1
V1.2
V1.3
V1.4
作者
刘磊
刘磊
陈浩
盛凯
刘磊
刘磊
徐驰
唐春龙
刘磊
王涛
刘磊
V1.4
刘磊
2012-8-30
V1.5
徐驰
唐春龙
2012-9-26 整理最新的说明文档
2
目录
1. 引言 .............................................................................................................................. 8
1.1. 目的 ................................................................................................................................ 8
1.2. 读者对象 ........................................................................................................................ 8
1.3. 文档内部约定 .................................................................................................................8
1.3.1. 文档字体约定...........................................................................................................8
1.4. 术语与缩写 .....................................................................................................................8
2. 方案概述 ........................................................................................................................ 9
2.1. 业务说明 .........................................................................................................................9
2.2. 业务流程 ....................................................................................................................... 11
2.3. API2.0 平台介绍 ........................................................................................................... 16
3. 数据格式 ...................................................................................................................... 20
3.1. 请求地址 ...................................................................................................................... 20
3.2. 请求类型 ...................................................................................................................... 20
3.3. 测试及正式访问 ...........................................................................................................24
3.3.1. 测试环境访问........................................................................................................ 24
3.3.2. 生产环境访问........................................................................................................24
3.4. 请求频次 .......................................................................................................................24
3.5. 签名原始串 ...................................................................................................................24
3.6. 签名算法 .......................................................................................................................25
3.6.1. MD5 签名原理........................................................................................................25
3.7. 接口介绍 .......................................................................................................................26
3.7.1. 用户 User ..............................................................................................................26
3.7.1.1. 用户生成 OTA_UserUniqueID ......................................................... 26
3.7.2. 酒店Hotel .............................................................................................................28
3.7.2.1. 静态文件下载 ......................................................................................28
3.7.2.2. 联通测试 OTA_Ping ......................................................................... 29
3.7.2.3. 酒店查询 OTA_HotelSearch .............................................................31
3
3.7.2.4. 酒店静态信息查询 OTA_HotelDescriptiveInfo ..............................38
3.7.2.5. 价格计划查询 OTA_HotelRatePlan .................................................53
3.7.2.6. 价格缓存变化查询 OTA_HotelCacheChange ..................................65
3.7.2.7. 可订检查 OTA_HotelAvail ................................................................ 69
3.7.2.8. 订单生成 OTA_HotelRes ..................................................................81
3.7.2.9. 订单取消 OTA_Cancel ..................................................................... 98
3.7.2.10. 订单变化查询 OTA_HotelResNotif ............................................. 102
3.7.2.11. 订单详情查询 OTA_Read ..............................................................107
3.7.2.12. 酒店列表查询 D_HotelSearch .....................................................118
3.7.2.13. 酒店详情 D_HotelDetail ............................................................. 137
3.7.2.14. 酒店订单列表查询 D_HotelOrderList ........................................166
3.7.2.15. 酒店订单详情查询 D_HotelOrderDetail .................................. 173
3.7.2.16. 酒店评价查询 D_HotelCommentList .........................................179
3.7.3. 国内机票Flight ...................................................................................................182
3.7.3.1. 静态文件下载 .................................................................................... 182
3.7.3.2. 国内机票查询 OTA_FlightSearch .................................................. 183
3.7.3.3. 国内机票生成订单 OTA_FltSaveOrder .......................................... 191
3.7.3.4. 国内机票取消订单 OTA_FltCancelOrder ......................................201
3.7.3.5. 国内机票订单列表 OTA_FltOrderList ........................................... 203
3.7.3.6. 国内机票订单详情 OTA_FltViewOrder ........................................ 208
3.7.3.7. 国内机票订单变更 OTA_GetStatusChangedOrders ..................... 218
3.7.4. 国际机票Flight ...................................................................................................221
3.7.4.1. 静态文件下载 .................................................................................... 221
4
3.7.4.2. 国际机票查询 OTA_IntlFlightSearch ............................................ 221
3.7.4.3. 机型信息查询 OTA_FltGetCraftInfos ............................................ 238
3.7.4.4. 城市查询 OTA_FltGetCityInfos ..................................................... 241
3.7.4.5. 机场查询 OTA_FltGetAirportInfos ............................................... 244
3.7.4.6. 航空公司信息 OTA_FltGetAirlineInfos ........................................ 246
3.7.5. 度假Vacations ................................................................................................... 249
3.7.5.1. 度假地址选择器 OTA_VacationAddressSelector ..........................249
3.7.5.2. 度假城市列表(热门城市) OTA_VacationCity ...........................252
3.7.5.3. 度假证件类型 OTA_VacationCredentialType ...............................255
3.7.5.4. 度假配送方式 OTA_VacationDeliverType .................................... 257
3.7.5.5. 度假酒店 OTA_VacationHotels ......................................................261
3.7.5.6. 度假订单金额计算 OTA_VacationOrderAmount .........................269
3.7.5.7. 度假临时订单生成 OTA_VacationOrderCreate .............................271
3.7.5.8. 度假订单列表 OTA_VacationOrderList ........................................299
3.7.5.9. 度假订单明细 OTA_VacationOrderInfo ....................................... 304
3.7.5.10. 度假产品单选项 OTA_VacationOrderItem ................................. 318
3.7.5.11. 产品查询列表 OTA_VacationPackageList ................................... 347
3.7.5.12. 产品明细 OTA_VacationPackageInfo ..........................................355
3.7.5.13. 度假暂存订单详情 OTA_VacationTmpOrderInfo ...................... 367
3.7.5.14. 度假系统机票 OTA_VacationSysFlight .......................................380
3.7.5.15. 度假可选项列表 OTA_VacationOrderOption ............................. 386
3.7.6. 支付.....................................................................................................................398
3.7.6.1. 在线支付 ........................................................................................... 398
5
3.7.6.2. 支付流水查询 GetPaymentInfo ..................................................... 400
3.7.7. 团购..................................................................................................................... 403
3.7.7.1. 团购产品列表查询 GroupProductList .............................................403
3.7.7.2. 团购产品详细查看 GroupProductInfo ...........................................407
3.7.7.3. 团购订单列表查询 GroupOrderList ................................................ 413
3.7.7.4. 团购订单生成 GroupCreateOrder ...................................................417
3.7.7.5. 团购券查询 GroupQueryTickets .................................................... 420
3.7.7.6. 团购订单通知 GroupOrderChange ................................................ 423
3.7.7.7. 团购产品通知 GroupProductChange .............................................426
3.7.7.8. 团购券通知 GroupTicketChange ................................................... 428
3.7.7.9. 团购券取消 GroupCancelTickets ....................................................431
4. 附录 .......................................................................................................................... 433
4.1. FAQ ............................................................................................................................. 433
4.1.1. 问:我运行程序后怎么一直报错误代码:签名错误?......................................433
4.1.2. 问:我怎么得到联盟身份(Alliance)和站点密钥(Secretkey)?.............. 434
4.1.3. 问:如果我只想使用酒店查询功能,然后跳转到CTRIP.com 完成预订怎么办?
........................................................................................................................................434
4.1.4. 问:System
error:no cache在什么情况下出现的?........................................................434
4.1.5. 问:我想通过API2.0 的OTA_HotelSearch 接口查找某个城市的所有酒店,好
像查不到请求如下。...............434
4.1.6. 问:酒店价格计划接口OTA_HotelRatePlan 可以一次查询多家酒店的价格吗?
........................................................................................................................................434
4.1.7. 问:“Server returned HTTP response code: 413”是什么问题?.................... 435
4.1.8. 问:我怎么知道我可以对接口的最大访问频次是多少?................................. 435
4.1.9. 问:AreaID 和BrandCode 对应的数据在哪里能找到。.................................435
4.1.10. 问:OTA_HotelRatePlan 返回的结果里RatePlanCode="559401"
RatePlanCategory="16"描述的是什么意思。............................................................ 435
4.1.11. 问:我之前用的是酒店API1.0 查询酒店信息的,请问现在提供的API2.0 查询
接口在使用方式上与API1.0 有区别吗?..................................................................... 436
6
4.1.12. 问:为什么我调用酒店API2.0 的可订性检查接口会抛下面的错。..............436
4.1.13. 问:酒店API2.0 新预订接口下单时,担保信息必须要填写吗?..................436
4.1.14. 问:酒店API2.0 新预订接口对于信用担保时录入的信用卡资料需要经过加密再
传入吗?.........................................................................................................................436
4.1.15. 问:酒店API2.0 搜索接口节点infotype 数
字对应的类型有哪些。..................................................................................................437
4.1.16. 问:酒店API2.0 的搜索接口提供最低价格的显示吗?................................. 437
4.1.17. 问:酒店API2.0 的搜索接口提供国外酒店的搜索吗?..................................437
4.1.18. 问:酒店API2.0 价格计划接口返回的内容中描述的是什么信息。
........................................................................................................................................438
4.1.19. 问:酒店API2.0 调用中报错...........................................................................438
4.1.20. 问:价格计划接口返回多个日期段的价格我该怎么取值。...........................438
4.1.21. 问:我用标准SOAP 请求名为*.asmx 的服务接口为什么连不上。.............. 438
4.1.22. 问:酒店API2.0 新预订接口的联系方式Contact Type 有哪几种?............438
4.2. 错误代码 .................................................................................................................... 439
7
1. 引言
1.1. 目的
本文描述了网站联盟 API 平台对联盟伙伴提供的接口化预订解决方案,帮助联盟伙伴轻
松实现酒店、机票、度假等在线旅游业务查询、预订、API 功能。文档分别从交互模式、签
名、接口、注意事项等方面详细介绍了 API 平台的工作方式和开发过程,可以帮助开发人员
快速入门并掌握开发技能,同时也可以作为日后接口参数及参数类型的速查手册。
1.2. 读者对象
本文档的预期读者为业务需求人员、开发经理、项目经理、架构设计师、开发人员、测
试人员、设计评审人员、用户文档编写者。
1.3. 文档内部约定
1.3.1. 文档字体约定
▲ 着重说明字体:对于本文中重要,易混淆,易疏忽的关键内容进行标记时使用
的字体
▲ 补充说明字体:为便于读者理解,文本在某些描述之后会使用现有系统的实际情况
举例,这是一种对于前文进行补充说明时使用的字体
▲ 待定信息字体:对于本文在编写时未确定,需与相关干系人进一步明确信息时使用
的字体
1.4. 术语与缩写
术语/缩写
解释
API
Application Programming Interface 应用程序接口
8