API文档

接口公共参数

参数列表

接口名称 说明
1.Http Headers 报文请求头
2.请求参数 报文请求头
3.响应参数 响应参数
3.系统返回码表 系统返回码表

1.Http Headers

Key 示例值 描述
Content-Type application/json http请求信息的格式,现只支持application/json格式，且只能有一个Content-Type
domain xiaoahotel 代表某一个酒店集团,如果酒店是通过域名 http:// xiaoahotel.beyondh.com 来访问别样红PMS系统的，则domain即为 xiaoahotel，且在header中只能有一个domain

2.请求参数

字段名 变量名 必填 类型 示例值 描述
渠道Key ChannelKey 是 string DA89B3D9-E87C-44E9-8037-1975D238A884 渠道Key决定了获取到的房价、房量和订单的渠道、来源，其值可在PMS系统中查看：销售管理->渠道凭证管理
接口名称 Method 是 String Hotel.GetHotelRoomTypes 指定调用的接口API
业务参数 BizContent 是 String {\"Name\":\"xiaoA\",\"Mobile\":\"13111111111\",\"CardNo\":\"\"} 指定调用的接口API需要的参数，格式是json字符串
数据格式 Format 是 String json 数据传输格式，目前只支持json格式
字符集 Charset 是 String uft-8 指定数据传输的字符集，目前只支持uft-8格式
版本 Version 是 String 1.0 调用的接口版本，目前固定为：1.0
时间戳 Timestamp 是 String 2017-11-10 13:39:05 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"
签名类型 SignType 是 String SHA256 请求参数的签名算法类型，目前只支持SHA256和MD5
签名 Sign 是 String 27983B51C682594A3B3C92E3B6194AFB241CC41A0C3B08BC06C36254C27F543C 请求参数的签名

3.响应参数

字段名 变量名 必填 类型 示例值 描述
系统返回码 Code 是 int 10000 系统返回码, 详见 4.系统返回码表
系统返回码描述 Message 是 String 接口调用成功 系统返回码代表的意思, 详见 系统返回码表
业务返回码 SubCode 否 String hotel.checkin-not-found 业务返回码，参见具体的API接口文档
业务返回码描述 SubMessage 否 String 入住单不存在 业务返回码描述，参见具体的API接口文档
业务返回结果 Data 是 String 业务接口返回的结果，参见具体的API接口文档

4.系统返回码表

Code
（返回码）		 Message
（返回码描述）		 SubCode
（业务返回码）		 SubMessage
（业务返回码描述）		 解决方案
10000 接口调用成功，调用结果请参考具体的API文档所对应的业务返回值
20000 未知错误 aop.unknow-error 未知错误 请做好日志记录，在出现此错误时，请提供完整的请求信息，以便支持人员查找错误原因。
30000 非法的请求 aop.invalid-http-method 不支持的HTTP数据传输方法 把Http请求的Method改为接口支持的方法，如："POST"
aop.invalid-content-type 无效的请求地址 把Http请求的Content-Type改为接口支持的格式，如："application/json"
aop.invalid-request-uri 不支持的ContentType 把Http请求的Content-Type改为接口支持的格式，如："application/json"
40001 缺少必要参数 aop.missing-domain-header 在http请求header中未发现有效的domain信息
aop.missing-http-body 缺少http请求的body信息 请传入合法的请求信息
aop.missing-sign 缺少签名参数 请参考 安全规范计算签名信息
aop.missing-channel-key 缺少渠道凭证 请按照上面 请求参数的要求传递相应的参数信息
aop.missing-method 缺少接口方法名参数
aop.missing-sign-type 缺少签名类型参数
aop.missing-format 缺少数据格式参数
aop.missing-charset 缺少字符集参数
aop.missing-charset 缺少字符集参数
aop.missing-version 缺少接口版本参数
aop.missing-timestamp 缺少时间戳参数
40002 非法的参数 aop.invalid-method 无效的接口方法名 检查接口方法名称和具体的业务方法
aop.missing-domain 缺少PMS域名参数 请按照上面 Http Header的要求传递相应的参数信息
aop.multi-domain-headers 在header中发现有多个domain信息
aop.invalid-json-message 无效的Json数据 请按照上面 请求参数的要求传递相应的参数信息
aop.invalid-sign-type 无效的签名类型
aop.invalid-format 无效的数据格式
aop.invalid-charset 无效的字符集
aop.invalid-version 无效的接口版本
aop.invalid-timestamp 无效的时间戳
aop.invalid-channel-key 无效的渠道凭证
aop.invalid-sign 无效的签名
50000 业务处理失败 请参考具体业务返回码