1. 后台接口

1.1. API V1 接口说明

接口基准地址：http://10.1.8.196:3001/
服务端已开启 CORS 跨域支持
使用 HTTP Status Code 标识状态
数据返回格式统一使用 JSON

1.1.1. 支持的请求方法

POST（CREATE）：在服务器新建一个资源。

1.1.2. 通用返回状态说明

状态码	含义	说明
200	OK	请求成功
202	warning	请求成功但是操作失败
500	INTERNAL SERVER ERROR	内部错误

1.2. 登录

1.2.1. 登录验证接口

登陆接口将返回用户信息与 token，请将 token 放入请求头，用户权限需要 token 判断

请求路径：login/auth
请求方法：post
请求参数

参数名参数说明备注

code string wx.login 返回的 res.code （用户登录凭证）

wxinfo object wx.getUserInfo 返回的 userInfo （用户信息）

参数名	参数说明	备注
code	string	wx.login 返回的 res.code （用户登录凭证）
wxinfo	object	wx.getUserInfo 返回的 userInfo （用户信息）

响应参数

参数名	参数说明	备注
userid	用户 ID	用户唯一 ID
openid	微信 openid
role	用户角色	房东：1；租客：0
userinfo	用户个人信息	房东认证或租客合同
nickName	微信昵称
avatarUrl	微信头像
token	用户权限凭证	请求头携带

1.3. 用户管理

1.3.1. 用户信息更新（支持房东认证）

房东认证之后需要重新更新 token，保证用户权限正常

请求路径：login/update/:cert
请求方法：post

请求参数

参数名	参数说明	备注
id	用户 ID	用户唯一 ID
name	用户真实姓名	必填
phone	用户真实电话	必填
idcard	用户身份证	必填
location	省市区	必填
village	乡镇	必填
cert	此次信息更新是否属于认证更新	cert:1(认证房东更新)cert:0(普通信息更新)[url 地址参数]

响应参数

参数名	参数说明	备注
nickName	微信昵称
role	用户角色	0：普通租客，1：房东
avatarUrl	微信用户头像
name	用户真实姓名
phone	用户真实电话
idcard	用户身份证
provinces	省市区
town	乡镇
token	用户权限凭证	请求头携带

1.3.2 获取用户信息

请求路径：query/userinfo
请求方法：post
请求参数 没有请求参数

响应参数

参数名	参数说明	备注
nickName	微信昵称
role	用户角色	0：普通租客，1：房东
avatarUrl	微信用户头像
name	用户真实姓名
phone	用户真实电话
idcard	用户身份证
provinces	省
city	市
area	区
village	乡镇

1.4. 房屋管理

房屋管理属于房东权限范围，服务端需要判断用户身份角色
请求头添加 authorization 字段，值为用户唯一 ID

1.4.1. 添加房屋

请求路径：build/add
请求方法：post
请求参数

参数名	参数说明	备注
landlordId	用户 ID （需要房东认证）	不能为空
buildInfo	公寓信息：{name,layer,count,net,electricity,water }	不能为空
houseType	户型:[ {unitType,bathroom ,air_condition ,geyser ,gas ,broadband ,clear ,rent } ]	不能为空

{
  "landlordId": "5fa242eae4bf8b369c2af91a",
  "buildInfo": {
    "name": "香蕉公寓",
    "layer": "5",
    "count": "10",
    "net": "5",
    "electricity": "5",
    "water": "5"
  },
  "houseType": [
    {
      "unitType": 1,
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0,
      "clear": 1000,
      "rent": 200
    }
  ]
}

响应参数

参数名	参数说明	备注
houseType	公寓所有户型信息	数组对象
landlordId	房东 ID	房东唯一 ID
_id	公寓 ID	公寓唯一 ID
buildInfo	建筑基本	对象记录层数，每层户数，名称
buildCost	建筑费用	记录网费、水费、电费

响应数据

{
  "data": {
    "houseType": [
      {
        "unitType": 5,
        "bathroom": 0,
        "air_condition": 0,
        "geyser": 0,
        "gas": 0,
        "broadband": 0,
        "clear": 1000,
        "rent": 200
      }
    ],
    "_id": "5fa2575e92cd3112041e3e7d",
    "landlordId": "5fa242eae4bf8b369c2af91a",
    "buildInfo": {
      "buildName": "香蕉公寓",
      "buildLayer": "5",
      "layerCount": "10"
    },
    "buildCost": {
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  },
  "meta": {
    "status": 200,
    "msg": "添加成功"
  }
}

1.4.2. 获取房东所有公寓

请求路径：/build/allbuild/:page/:size
请求方法：post
请求参数

参数名	参数说明	备注
id	用户 ID （需要房东认证）	不能为空
page	number	页数
size	number	容量

响应参数

参数名	参数说明	备注
rooms	数组对象，对象内字段是房间信息	第一栋公寓所有房间信息
ret	数组对象，对象内公寓信息	_id：公寓唯一 ID, buildInfo:公寓基本信息

响应数据

{
"data": {
        "ret": [
                  {
                  "_id": "5fa2575e92cd3112041e3e7d",
                  "buildInfo": {
                    "buildName": "香蕉公寓",
                    "buildLayer": "5",
                    "layerCount": "10"
                  }

        ],
                "rooms": [
                  {
                "houseStatus": 0,
                "_id": "5fa2575e92cd3112041e3e7e",
                "houseName": "101房",
                "houseType": 1,
                "houseConfig": {
                    "bathroom": 0,
                    "air_condition": 0,
                    "geyser": 0,
                    "gas": 0,
                    "broadband": 0
                },
                "houseCost": {
                    "clear": 1000,
                    "rent": 200,
                    "net": "5",
                    "electricity": "5",
                    "water": "5"
                }
            }]
},
    "meta": {
        "status": 200,
        "msg": "查询成功"
    }

1.4.3. 根据公寓 ID 获取公寓信息

请求路径：/build/buildinfo
请求方法：post
请求参数

参数名	参数说明	备注
id	公寓唯一 ID	不能为空

响应参数

参数名	参数说明	备注
houseType	户型：数组对象	记录批量生成房间的数据模型
buildInfo	公寓信息:名称，层数，每层户数	公寓基本信息
buildCost	公寓费用:网费、电费、水费	公寓基本信息

响应参数

{
  "data": {
    "houseType": [
      {
        "unitType": 5,
        "bathroom": 0,
        "air_condition": 0,
        "geyser": 0,
        "gas": 0,
        "broadband": 0,
        "clear": 1000,
        "rent": 200
      }
    ],
    "buildInfo": {
      "buildName": "香蕉公寓",
      "buildLayer": "5",
      "layerCount": "10"
    },
    "buildCost": {
      "net": "5",
      "electricity": "5",
      "water": "5"
    }
  },
  "meta": {
    "status": 200,
    "msg": "信息获取成功"
  }
}

1.4.4. 根据公寓 ID 修改公寓信息

请求路径：/build/buildupdata
请求方法：post
请求参数

参数名	参数说明	备注
id	公寓唯一 ID	不能为空
buildInfo	对象类型：公寓基本信息	不能为空
houseType	数组对象：户型数组	不能为空

{
  "id": "5fa2575e92cd3112041e3e7d",
  "buildInfo": {
    "name": "辣椒公寓",
    "layer": "5",
    "count": "10",
    "net": "5",
    "electricity": "5",
    "water": "5"
  },
  "houseType": [
    {
      "unitType": 5,
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0,
      "clear": 1000,
      "rent": 200
    }
  ]
}

响应参数

参数名	参数说明	备注
_id	公寓唯一 ID
landlordId	房东唯一 ID	需要用户认证
buildInfo	公寓基本信息：对象
buildCost	公寓基本费用：对象
houseType	数组对象：户型数组

响应参数

{
  "data": {
    "houseType": [
      {
        "unitType": 5,
        "bathroom": 0,
        "air_condition": 0,
        "geyser": 0,
        "gas": 0,
        "broadband": 0,
        "clear": 1000,
        "rent": 200
      }
    ],
    "_id": "5fa2575e92cd3112041e3e7d",
    "landlordId": "5fa242eae4bf8b369c2af91a",
    "buildInfo": {
      "buildName": "辣椒公寓",
      "buildLayer": "5",
      "layerCount": "10"
    },
    "buildCost": {
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  },
  "meta": {
    "status": 200,
    "msg": "信息修改成功"
  }
}

1.4.5. 根据公寓 ID 返回公寓内的房间

请求路径：/build/allhouse
请求方法：post
请求参数

参数名	参数说明	备注
id	公寓唯一 ID	不能为空

响应参数

[
  {
    "houseStatus": 0,
    "_id": "5fa2575e92cd3112041e3e7e",
    "houseName": "101房",
    "houseType": 1,
    "houseConfig": {
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0
    },
    "houseCost": {
      "clear": 1000,
      "rent": 200,
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  },
  {
    "houseStatus": 0,
    "_id": "5fa2575e92cd3112041e3e7e",
    "houseName": "101房",
    "houseType": 1,
    "houseConfig": {
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0
    },
    "houseCost": {
      "clear": 1000,
      "rent": 200,
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  }
]

1.4.6. 根据公寓 ID 返回公寓内的房间

请求路径：/build/house/:type/:page/:size/:status
请求方法：post
请求参数

参数名	参数说明	备注
id	公寓唯一 ID	请求体中的参数
type	房间户型 Number	地址参数
page	第几页 Number	地址参数
size	每页容量 Number	地址参数
status	未发布：0 发布未出租：1 已出租：2 ;Number	地址参数

请求地址：http://localhost:3001/build/house/2/1/10/1
请求体
{
    "id": "5fa2575e92cd3112041e3e7d"
}

响应参数

{
  "data": [
    // 数组内是 房间的信息
    {
      "houseStatus": 0,
      "_id": "5fa2575e92cd3112041e3e87",
      "houseName": "110房",
      "houseType": 1,
      "houseConfig": {
        "bathroom": 0,
        "air_condition": 0,
        "geyser": 0,
        "gas": 0,
        "broadband": 0
      },
      "houseCost": {
        "clear": 1000,
        "rent": 200,
        "net": "5",
        "electricity": "5",
        "water": "5"
      },
      "__v": 0
    }
  ],
  "count": 10, // 条件参数所命中的统计数
  "meta": {
    "status": 200,
    "msg": "条件查询成功"
  }
}

1.4.7. 房屋 ID 出租屋状态

enum: [0, 1, 2], // 未发布发布未出租已出租

请求路径：/build/changestatus
请求方法：post
请求参数

参数名	参数说明	备注
id	出租屋唯一 ID
status	状态值	（0：未发布，1：发布未出租，2：已出租）

响应参数

参数名	参数说明	备注
houseStatus	出租屋状态未发布：0 发布未出租：1 已出租：2
_id	出租屋唯一 ID
houseName	出租屋名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋基本消费

返回参数

{
  "data": {
    "houseStatus": 2,
    "_id": "5fa2575e92cd3112041e3e7e",
    "houseName": "101房",
    "houseType": 1,
    "houseConfig": {
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0
    },
    "houseCost": {
      "clear": 1000,
      "rent": 200,
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  },
  "meta": {
    "status": 200,
    "msg": "状态改变成功"
  }
}

1.4.8. 房屋 ID 房间信息更新

请求路径：/build/houseupdata
请求方法：post
请求参数

参数名	参数说明	备注
id	出租屋唯一 ID
houseName	房间名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋消费

{
  "id": "5fa2575e92cd3112041e3e7e",
  "houseName": "1024房",
  "houseType": 2,
  "houseConfig": {
    "bathroom": 0,
    "air_condition": 0,
    "geyser": 0,
    "gas": 0,
    "broadband": 0
  },
  "houseCost": {
    "clear": 1000,
    "rent": 200,
    "net": 5,
    "electricity": 5,
    "water": 6
  }
}

响应数据

参数名	参数说明	备注
id	出租屋唯一 ID
houseName	房间名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋消费

{
  "data": null,
  "meta": {
    "status": 200,
    "msg": "信息更新成功"
  }
}

1.4.9. 房东新加房

请求路径：/build/newhouse
请求方法：post
请求参数

参数名	参数说明	备注
buildId	公寓唯一 ID
houseName	房间名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋消费

响应参数

参数名	参数说明	备注
houseStatus	出租屋状态未发布：0 发布未出租：1 已出租：2
_id	出租屋唯一 ID
houseName	出租屋名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋基本消费

1.5. 通用接口（无权限限制）

1.5.1. 房屋 ID 查询房屋具体信息

请求路径：/query/houseinfo
请求方法：post
请求参数

参数名	参数说明	备注
id	出租屋唯一 ID	请求体中的参数

响应参数

参数名	参数说明	备注
houseStatus	出租屋状态未发布：0 发布未出租：1 已出租：2
_id	出租屋唯一 ID
houseName	出租屋名称
houseType	出租屋户型
houseConfig	出租屋基本配置
houseCost	出租屋基本消费

{
  "data": {
    "houseStatus": 0,
    "_id": "5fa2575e92cd3112041e3e7e",
    "houseName": "101房",
    "houseType": 1,
    "houseConfig": {
      "bathroom": 0,
      "air_condition": 0,
      "geyser": 0,
      "gas": 0,
      "broadband": 0
    },
    "houseCost": {
      "clear": 1000,
      "rent": 200,
      "net": "5",
      "electricity": "5",
      "water": "5"
    },
    "__v": 0
  },
  "meta": {
    "status": 200,
    "msg": "查询成功"
  }
}

1.6 合同相关

1.6.1 初始化合同

请求路径：/contr/init
请求方法：post
请求参数

参数名	参数说明	备注
roomId	出租屋唯一 ID	用户 id
beginTime	起始出租时间	Date.now()
landlordId	房东用户 ID	用户 id
houseName	房间名称
houseType	户型（1 房或*房）	Number 类型
houseConfig	{bathroom,air_condition,geyser,gas,broadband}	object 类型;属性值 Number 类型
houseCost	{clear,,rent,net,electricity,water}	object 类型;属性值 Number 类型
Baseinfo	{electric,water,}	object 类型;属性值 Number 类型

响应参数

参数名	参数说明	备注
id	合同唯一 ID	发送到租客激活合同有效性

1.6.2 激活合同

请求路径：/contr/visa
请求方法：post
请求参数

参数名	参数说明	备注
id	合同唯一 ID	确认激活有效性的合同 id
tenantId	租客用户 ID
persons	住房人数
phone	租客电话	选填
idcard	租客身份证号	选填

响应参数

{
  "data": null,
  "meta": {
    "msg": "合同签订成功",
    "status": 200
  }
}

1.6.3 查询所有账单

请求路径：/bill/getbills
请求方法：post
请求参数

参数名	参数说明	备注
id	公寓 ID	相关公寓所有合同

1.6.4 查询账单详细信息

请求路径：/bill/getbill
请求方法：post
请求参数

参数名	参数说明	备注
id	账单 ID

1.6.4 发送账单

请求路径：/bill/setbills
请求方法：post
请求参数

参数名	参数说明	备注
id	账单 ID
curWater	Number	当前水表读数
curElectric	Number	当前电表读数
toalCost	Number	账单总价

1.6.5 合并账单

请求路径：/bill/oldbill
请求方法：post
请求参数

参数名	参数说明	备注
id	账单 ID

1.6.5 支付账单

请求路径：/bill/payment
请求方法：post
请求参数

参数名	参数说明	备注
id	账单 ID

接口调整

确认租房合同的接口房东能够进入确认租房页面在确认租房之前判断合同所关联的房东ID与

crazy23lt/rental

1. 后台接口

1.1. API V1 接口说明

1.1.1. 支持的请求方法

1.1.2. 通用返回状态说明

1.2. 登录

1.2.1. 登录验证接口

1.3. 用户管理

1.3.1. 用户信息更新（支持房东认证）

1.3.2 获取用户信息

1.4. 房屋管理

1.4.1. 添加房屋

1.4.2. 获取房东所有公寓

1.4.3. 根据 公寓 ID 获取公寓信息

1.4.4. 根据 公寓 ID 修改公寓信息

1.4.5. 根据 公寓 ID 返回 公寓内的房间

1.4.6. 根据 公寓 ID 返回 公寓内的房间

1.4.7. 房屋 ID 出租屋状态

1.4.8. 房屋 ID 房间信息更新

1.4.9. 房东新加房

1.5. 通用接口（无权限限制）

1.5.1. 房屋 ID 查询房屋具体信息

1.6 合同相关

1.6.1 初始化合同

1.6.2 激活合同

1.6.3 查询所有账单

1.6.4 查询账单详细信息

1.6.4 发送账单

1.6.5 合并账单

1.6.5 支付账单

接口调整

1.4.3. 根据公寓 ID 获取公寓信息

1.4.4. 根据公寓 ID 修改公寓信息

1.4.5. 根据公寓 ID 返回公寓内的房间

1.4.6. 根据公寓 ID 返回公寓内的房间