房管通网站对接接口规范.doc

房管通网站对接接口规范 目录 房管通网站对接接口规范 1 目录 1 1. 文档目的 3 2. 对接数据规范 4 2.1 用户注册/登录授权 4 2.1.1 用户账号授权——注册 4 2.1.2 用户账号授权——登录 5 2.1.3 基于授权协议授权——注册/登录 5 2.2 用户信息 7 2.2.1 房管通推送用户信息 7 2.3 酒店信息 9 2.3.1 房管通推送酒店信息 9 2.4 房源信息 15 2.4.1 房管通推送房源信息 15 2.4.2 房管通拉取房源信息 21 2.5 房价设置 22 2.5.1 平日价设置 22 2.5.2 周末价设置 23 2.5.3 特殊时段价设置 24 2.5.4 周价设置 25 2.5.5 月价设置 26 2.6 规则设置 27 2.7 房态设置 28 2.8 订单信息 29 2.8.1 房管通拉取订单信息 29 分页订单拉取 29 单个订单拉取 31 2.8.2 合作网站推送订单通知 32 2.8.3 房管通推送订单操作信息 33 3. 技术规范 35 3.1 用户授权 35 3.1.1 建立授权 35 3.1.2 授权取消 37 3.1.3 授权登录示例 37 4. 业务数据要求 39 4.1 目的 39 4.2 示例 39 4.2.1 能租网的业务数据要求 39 文档目的 业务对接涵盖内容如下： 用户注册 用户信息 酒店信息 房源信息 房价设置，包括：平日价设置、周末价设置、特殊时段价设置、周价设置、月价设置 规则设置 房态设置 订单信息 对接数据规范 下文根据业务对接内容，具体描述对接数据规格（数据格式按照JSON格式描述）。 用户注册/登录授权 用户的授权方式分为两种： 用户账号授权。这种授权方式需要在房管通系统中存储用户在合作网站的账号密码 基于授权协议授权。这种授权方式下房管通无需存储用户在合作网站的账号密码，但是需要合作网站提供登录授权页面及注册授权页面，并基于授权协议生成授权验证码。（技术规范请参考下文3.2章节） 用户账号授权 业务描述： 新店家用户在房管通可以直接注册合作网站的酒店账号，通过这样的方式也同时增加了合作网站的加盟酒店； 该业务要求房管通向合作网站推送用户注册的信息。网站根据房管通提供的用户注册信息返回该新账号在本网站注册的处理结果。 店家用户在房管通上输入注册信息后，由房管通向合作网站推送用户注册的信息（如用户名、密码等），合作网站根据此注册信息处理注册并返回注册结果 数据规范： 房管通推送数据的规格如下： 参数名 参数类型 备注 字符型 用户注册账户名 password 字符型 用户注册账户密码 参数名 参数类型 备注 整型 1：处理成功， msg 字符型 提示信息 data 数据结果（与用户登录相关的额外信息在这里返回可以为空） 合作网站预先提供关于本网站用户注册的规则信息，例如：用户名长度要求、用户名是否可以包含空格和汉字、最低长度要求等 用户账号授权——登录 业务描述： 合作网站已有的店家用户可通过房管通登录到本网站上。后续操作中，店家用户将使用该登录账号，维护其在合作网站上的房态、房价、房源等信息，实现信息相互间的实时传递与更新） 该业务要求房管通向合作网站推送用户登录的信息。网站根据房管通提供的用户登录信息返回该用户在本网站登录的处理结果。 店家用户在房管通上输入登录信息后，由房管通向合作网站推送用户登录的信息（如用户名、密码等），合作网站根据此登录信息处理登录并返回登录结果 数据规范： 房管通推送数据的规格如下： 参数名 参数类型 备注 字符型 用户账户名 password 字符型 用户账户密码 合作网站返回的处理结果数据（JSON格式）的规格如下： 参数名 参数类型 备注 整型 1：处理成功，0值表示处理不成功 msg 字符型 提示信息 data 备注补充： 合作网站预先提供关于本网站用户， 基于授权协议授权——注册/登录 业务描述： 在该模式下，店家用户无须在房管通中存储其在合作网站上的用户名和密码信息 该业务要求合作网站提供注册、登录授权页面。用户的注册/登录操作及信息均在合作网站的服务器上执行，对房管通完全透明。 店家用户在房管通点击注册/登录按钮时将以弹框iframe的方式请求链接到合作网站的授权处理地址。网站根据房管通提供的参数进行业务处理及页面跳转（跳转到注册/登录授权页面）。店家输入注册/登录信息，合作网站处理注册/登录完成后应基于授权协议生成唯一标识的授权码作为参数传到房管通指定处理注册授权的链接/api/oauth/oauth_redirect(请使用GET方式请求)。 数据规范： 房管通推送数据的规格如下： 参数名 参数类型 备注 ”login”、”register”、”close