Catkit接口整理
一、登陆和注册
注:若用户已经处于登陆状态,则在向服务器发出的每条请求,都应带上客户端储存的cookie,其中带有userId等用户信息,用于服务端识别请求的身份,保持会话机制。
1. 登陆
向服务器请求登陆
接口名称:login
注:若用户使用手机号登陆,则用户的昵称和头像为空,此时使用服务端随机生成昵称,默认头像;若使用微信号登陆,使用微信昵称和微信头像
请求参数类型:Object
请求参数:
参数 | 类型 | 说明 |
---|---|---|
phoneNumber(或用户的微信号、昵称) | String | 用户的手机号 |
openId | String | 微信用于识别身份的标志 |
返回参数类型: Object
返回参数:
参数 | 类型 | 说明 |
---|---|---|
userId | String | 用户在我们的小程序中的id。如果用户第一次登陆,则需要后端进行 |
userName | String | 用户的名字(保留) |
nickName | String | 用户昵称 |
avatar | String | 用户的头像url |
weId | String | 用户的微信号 |
二、首页
1.获取添加的设备列表:
展示首页的已经添加的设备。
接口名称: “myDevList”
方法:get
请求参数类型:无参数
返回类型: Array
item参数类型: Object
item参数:
参数名 | 类型 | 说明 |
---|---|---|
id | String | 设备id |
name | String | 设备名 |
temperature | number | 当前温度 |
isOn | boolean | 是否处于开机状态 |
icon | String | 显示图标的url地址 |
type | String | 设备类型 |
例:
[
{
id: "dev001",
name: "瓜瓜的小窝1",
temperature: 27,
isOn: false,
icon: "/images/plus.png",
type: "cattery" //设备的类型
},
{
id: "dev002",
name: "瓜瓜的小窝2",
temperature: 27,
isOn: false,
icon: '/images/plus.png',
type: "cattery"
}
]
2. 请求具体设备的信息
在首页点击查看具体的设备情况
接口名称: “myDevDetail”
方法:get
请求参数类型:Object
请求参数:
参数名 | 类型 | 说明 |
---|---|---|
devId | String | 所请求的设备的Id |
返回类型: Object
返回参数:
参数名 | 类型 | 说明 |
---|---|---|
name | String | 设备的名字 |
currentTemperature | number | 当前温度 |
initTemperature | number | 初始温度 |
goalTemperature | number | 目标温度 |
predictCost | number | 预计花费时间(分钟) |
例:
{
name: "猫窝名",
currentTemprature: 27,
initTemperature: -273,
goalTemperature: 7777777.
predictCost: 1,
}
3.添加设备
添加设备
接口名称: “addMyDev”
方法:get
请求参数类型:Object
请求参数:
参数名 | 类型 | 说明 |
---|---|---|
name | String | 设备名称 |
type | String | 设备类型 |
例:
[
{
name: "瓜瓜的小窝1",
type: "cattery" //设备的类型
},
{
name: "瓜瓜的小窝2",
type: "cattery"
}
]