:-: 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)