[关闭]
@code33 2016-04-14T11:42:21.000000Z 字数 5509 阅读 973

OTA BS对接接口 阿里信用住 1.0.0

接口文档 迪联文档 阿里信用住 OTA

Bs服务端提供的接口(需求接口由使用方提供)

该模块由本地应用服务使用方提供
头信息是否有规范?!
contentType:application/json

NEEDAPI.试单接口(GET)

请求参数:
sendData:

  1. {
  2. "hotelid":"dlhis123",
  3. "roomTypeId":"dlhis123_BJ",
  4. "checkIn":"2016-01-04",
  5. "checkOut":"2016-01-06",
  6. "roomNum":"1",
  7. "ratePlan":"RP100052"
  8. }

响应参数:
return:
无房

  1. {"code":"1"}

有房

  1. {
  2. "code":"0",
  3. "room":[
  4. {
  5. "hotelid":"dlhis123",
  6. "rmtype":"dlhis123_BJ",
  7. "rmtype_dec":"标间",
  8. "sysdate":"2016-01-04",
  9. "rm_avl":"1",
  10. "rm_price":"3000"
  11. }
  12. ]
  13. }

NEEDAPI.接收ota订单接口(POST)

PS:
订单状态:orderStatus
淘宝订单号:taoBaoOrderId

以上字段请参照阿里API规范

sendData:

  1. {
  2. "taoBaoOrderId":"str.淘宝订单号",
  3. "hotelid":"str.酒店id",
  4. "roomTypeId":"str.房型代码(CONCAT(hotelid,'_','本地房型代码'))",
  5. "ratePlanCode":"str.房价计划",
  6. "roomNum":"str.房间数",
  7. "orderStatus":"str.订单状态(from阿里)",
  8. "checkIn":"date.2001-01-01抵",
  9. "checkOut":"date.2001-01-02离",
  10. "totalPrice":"str.总房价不含杂费(以分为单位)"
  11. "paymentType":int.[1,2,3参照阿里API规范]
  12. "contactName":"str.订单联系人",
  13. "contactTel":"str.订单联系电话",
  14. "dailyInfos":[
  15. {
  16. "day":"date.2016-03-10",
  17. "price":"str.20000(以分为单位)"
  18. }
  19. ],
  20. "orderGuests":宾客信息 参照阿里规范?!数据类型,
  21. "mkt":"str.QUA.define",
  22. "remark":"str.备注",
  23. "orderType":"枚举字符参照样样规范",//todo
  24. "receiptInfo":{},//不得为NULL,可空对象
  25. "log_date":"datetime.2001-01-01 12:00:00"
  26. }

响应结果集:

成功:

  1. {"BackCode":int.0,"BackMsg":"str.订单接收成功"}

失败:

  1. {"BackCode":int.1,"BackMsg":"str.订单接收失败"}

NEEDAPI.接收取消ota订单接口(Post) //消费者(OTA客户)主动取消

sendData:

  1. {
  2. "hotelid":"str.酒店ID",
  3. "taoBaoOrderId":"str.淘宝订单",
  4. "mkt":"str.市场码QUA.define",
  5. "reason":"str.取消原因可以不填么?"
  6. }

return:
成功:

  1. {"BackCode":int.0,"BackMsg":"str.订单取消成功"}

失败:

  1. {"BackCode":int.1,"BackMsg":"str.订单取消失败"}

ota服务器(基础数据推送接口)

DOMAIN:

API.获取房价计划code

此API仅用于新增房价计划
METHOD:GET
URL:/RequestService/BasicDataServlet

参数说明:
* serviceName(子服务名称)
* hotelid(酒店ID)
* type(获取唯一码类型,RP代表获取rate_plan唯一码)

get请求样式:
http://domain.com/url?data=sendata
sendData :

  1. {
  2. "serviceName":"ratePlan_code_get",
  3. "hotelid":"HD10000001",
  4. "requestData":{
  5. "type":"RP"
  6. }
  7. }

响应结果集:
return:

  1. {
  2. "responseOp":"ratePlan_code_get",
  3. "status":"0",
  4. "responseCode":"0000",
  5. "responseData":"RP100001"
  6. }

status为0 成功,否则异常


API.酒店信息的添加/修改(POST)

METHOD:POST
URL:/RequestService/BasicDataServlet
contentType //todo
contetnType:application/json
html
plain
text

参数说明:
* serviceName(操作名字)
* hotelid(酒店唯一码)使用方提供
* name (酒店名称)
* city (酒店所在城市代码)由阿里提供
* address
* tel
* vendor (默认dilian)仅用于阿里信用住
* description (酒店简介)todo 最大长度
* district (酒店所在区域代码)由阿里提供

sendData requsetBody:

  1. {
  2. "serviceName":"hotel_add_update",
  3. "hotelid":"HD10000001",
  4. "requestData":{
  5. "name":"迪联酒店",
  6. "city":"110100",
  7. "address":"杭州下城区",
  8. "tel":"0086#0571#89297321(0571#89297321)/(057189297321)",可以不带国际区号,可以不需要连接符
  9. "vendor":"dilian",
  10. "description":"酒店描述"
  11. }
  12. }

响应格式:
return:

  1. {
  2. "responseOp":"hotel_add_update",
  3. "status":"0",
  4. "responseCode":"0000",
  5. "responseData":"no data"
  6. }

status为0成功,否则异常


API.房型信息的添加/修改(POST)

METHOD:POST
URL:/RequestService/BasicDataServlet

参数说明:

sendData requsetBody:

  1. {
  2. "serviceName":"rmtype_update_add",
  3. "hotelid":"HD10000001",
  4. "requestData":{
  5. "rmtype_id":"RP000001",
  6. "name":"含早提前3天",
  7. "internet":"A",
  8. "windows_type":"0",
  9. "vendor":"dilian"
  10. }
  11. }

return:

  1. {
  2. "responseOp":"rmtype_update_add",
  3. "status":"0",
  4. "responseCode":"0000",
  5. "responseData":"no data"
  6. }

status为0成功,否则异常


API.房价计划信息的添加/修改(POST)缺担保类型字段

METHOD:POST
URL:/RequestService/BasicDataServlet
其中向阿里提供的字段请参照 阿里API规范
参数说明

  1. {
  2. "serviceName":"rateplan_add_update",
  3. "hotelid":"str.HD10000001",
  4. "requestData":{
  5. "rateplan_code":"str.RP000001",
  6. "name":"str.含早提前3天",
  7. "payment_type":"str.6",
  8. "breakfast_count":"str.0",
  9. "cancel_policy":{
  10. "cancelPolicyType":1
  11. },
  12. "status":"str.1",
  13. "vendor":"str.dilian"
  14. }
  15. }

响应格式:
return:

  1. {
  2. "responseOp":"rateplan_add_update",
  3. "status":"0",
  4. "responseCode":"0000",
  5. "responseData":"no data"
  6. }

status为"0"时正常 否则异常


ota服务器(业务订单进度变更如[入住,离店,取消,noshow以及结账,撤销结账])

DOMAIN:

API.信用住撤销结账接口

METHOD:POST
URL:/ResponseService/DlOrderCancelSettle
sendType:
http://domain/url?data=sendData

sendData:

  1. {
  2. "tid":"淘宝单号",
  3. "reason":"撤销结账原因",
  4. "hotelid":"酒店ID",
  5. "dogid":"本地识别号*mapping with hotelid"
  6. }

renturn:

成功:

  1. {"data":{"code":99,"reason":"结果"}}

失败:

  1. {"data":{"code":50,"reason":"结果"}}

API.信用住结账接口

METHOD:POST
URL:/ResponseService/DlOrderSettle
sendType:
http://domain/url?data=sendData
sendData:

  1. {
  2. "hotelid":"酒店ID",
  3. "mkt":"市场码",
  4. "tid":"淘宝单号",
  5. "memo":"备注",
  6. "room_no":"房号",
  7. "other_fee":"str.杂费总额.分单位",
  8. "total_room_fee":"str.房费总额.分单位",
  9. "daily_price_info":参照阿里规范,
  10. "check_out":"datetime.结账离店时间",
  11. "check_in":"datetime.实际入住时间",
  12. "other_fee_detail":参照阿里规范
  13. }

return:
成功:

  1. {"data":{"code":99,"reason":"结果"}}

失败:

  1. {"data":{"code":50,"reason":"结果"}}

API.信用住 订单业务 操作员处理 接口(操作员操作)

METHOD:POST
URL:/ResponseService/DlOrderCheckIn
sendType:
http://domain/url?data=sendData

参数说明:
checkout_date:客人实际离店日期,opt_type=4时必填
checkin_date:客人实际入住日期,opt_type=3/4时必填
reason_text:无房原因描述,opt_type=1时必填
reason_type:无房原因分类[1,2,3,4]
1:无房,
2:价格变动,
3:买家原因,
4:其它原因

opt_type:[8,5,3,4]
8:取消订单(cancel)用于订单确认后关单,必须在和买家协商通过的情况下操作,否则有法务风险;
5:买家未入住(noshow),会扣取买家的担保金额;
3:核实入住(checkIn);
4:核实离店(checkOut)

sendData:

  1. {
  2. "hotelid":"str.酒店编号",
  3. "mkt":"str.QUA.define",
  4. "tid":"str.淘宝单号",
  5. "opt_type":"str.操作的类型[8,5,3,4]",
  6. "reason_type":"str.无房原因分类[1,2,3,4]",
  7. "reason_text":"str.无房原因描述['描述1','描述2'],可空字符串",
  8. "out_room_number":"str.入住房间号",
  9. "checkin_date":"datetime.实际入住时间,默认空字符串",
  10. "checkout_date":"datetime.结账离店时间,默认空字符串",
  11. "rooms":"str.实际预定房间数不可小于1"
  12. }

return:
成功:

  1. {"data":{"code":int.99,"reason":"结果"}}

失败:

  1. {"data":{"code":50,"reason":"结果"}}
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注