:-: API 说明
#
1. 本次测试服务器(公司内部机器访问不到可能是管理员关闭了电脑~ ~!)
####
---> http : 101.68.67.138:8082
---> mqtt: 116.62.206.168:1943
*****
2. API组成
api入口 ---> api
api版本 ---> v1
api对象 ---> 具体看接口
api动作 ---> 具体看接口
示例 ----> http://host/api/v1/user/regist
*****
3. 本地操作(该操作需要与网关同在一个网段)
操作入口为单一入口固定位/DeviceController 端口固定为10006
示例 ----> http://udp获取的IP:10006/DeviceController
参数统一为json格式
*****
4. 全局申明
经过他们讨论需要加上权限验证来控制请在所有业务接口(public api 除外)POST时 + access_token(登录接口获取)
*****
5. 错误码说明
####
| 公共码 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 10001 | 系统错误 |
| 10002 | 系统繁忙 |
| 10003 | 输入参数规则错误 |
| 10004 | access_token 错误或者 access_token 已经失效 |
| 10005 | 不明确的意图 |
| 用户 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 20001 | 手机号格式无效 |
| 20002 | 密码格式无效(字符下划线数字6-16位) |
| 20003 | 无效的验证码或者验证码过期 |
| 20004 | 重复的用户 |
| 20005 | 用户不存在 |
| 20006 | 用户不存在或密码错误 |
| 20007 | 原密码错误 |
| 家 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 30001 | 家不存在 |
| 30002 | 必须保留一个家 |
| 31000 | 房间不存在 |
| 32000 | 网关不存在 |
| 设备 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 40001 | 添加设备报文有误 |
| 40002 | 设备不存在 |
| 40003 | 设备已存在 |
| 场景 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 50001 | 添加场景报文有误 |
| 50002 | 场景不存在|
| 智能 |
| --- | --- |--- |
| 返回码 | 说明 |
| --- | --- |
| 0 | 请求成功 |
| 60001 | 添加智能控制报文有误 |
| 60002 | 智能控制不存在|
| 60003 | 此设备已被其他智能控制设定|
| 60004 | 该设备已设定为条件设备,无法选择该设备|
*****
- 说明
- 用户操作
- 用户注册(0001)
- 发送验证码(0002)
- 忘记密码(0003)
- 用户登录(0004)
- 用户修改密码(0014)
- 用户信息修改(0033)
- 图片上传(0034)
- 用户基本信息获取(0035)
- 家的操作
- 创建家(0005)
- 删除家(0006)
- 修改家名称(0007)
- 获取家列表(0008)
- 房间的操作
- 创建房间(0010)
- 删除房间(0011)
- 修改房间名称(0012)
- 获取房间列表(0013)
- 网关的操作
- 创建网关(0014)
- 修改网关(0015)
- 删除网关(0016)
- 获取网关(0017)
- 搜索网关(0018)
- 设备操作
- 打开设备入网(0019)
- 搜索设备(0020)
- 创建设备(0021)
- 修改设备(0022)
- 删除设备(0023)
- 获取设备(0024)
- 设备消息推送(0033)
- 设备控制(0034)
- 获取设备节点(0035)
- 修改节点(0036)
- 天气操作
- 获取天气(0025)
- 场景操作
- 添加场景(0026)
- 删除场景(0027)
- 修改场景(0028)
- 获取场景(0029)
- 场景操作(0043)
- 智能控制操作
- 添加智能操作/修改智能操作(0030)
- 删除智能控制(0031)
- 获取智能控制(0032)
- 开启智能(0042)
- 更新说明
- 杂项
- 消息列表(0037)
- 遥控类型获取(0038)
- 遥控器品牌(0039)
- 获取遥控器型号(0040)
- 获取遥控器按键(0041)
- 节点绑定遥控器(0044)
- 解绑遥控器(0045)