此目錄包含三級系統的項目的說明和相關接口的使用。
## API 說明
* 訪問形式統一以 地址 + index 進行訪問,文檔的接口地址全面默認去除 index ,需要用的時候請自己添加
* 使用的時候可以把域名 + /index 進行拼接來訪問
* API 返回的數據說明,code 表示服務端返回的消息狀態,目前只包含兩個值, 0 => 請求或操作成功 , -1 => 請求操作失敗
~~~
{ code:0 } // 請求成功不包含消息體
{ code:0, data:[] } // 包含消息內容
{ code: -1,msg:'錯誤' } // 請求失敗,加錯誤消息
~~~
>[danger] 請求成功返回的內容格式不固定,請根據具體的接口返回進行操作
> 請求失敗返回的格式一致都包含 code -1 msg 錯誤消息
* 在文檔結果里面 debug 表示調試的時候數據返回, success 表示正式數據返回, error 表示錯誤信息返回 , 若沒有 debug 表示正式和調試返回的數據格式是一致的。 具體的信息請參考具體的返回內容。
>[danger] 服務端返回的數據會帶有 http 狀態碼
> 403 表示沒有訪問權限
> 401 表示沒有登錄
> 400 表示包含錯誤
> 200 請求正常返回
## 權限設計
* 權限設計到的數據庫表有 `auth_power` 、`auth_role` 分別是權限表和角色表, 具體可以參考數據庫注釋
* 權限設計通過配置文件的形式根據提供的接口和路由進行相應的配置,具體的配置文件存放在 admin / common / Configs.php 里面
* 權限檢查,通過和登錄檢查一樣的檢查方式,在檢查路由的時候加上一下代碼,篩選不用檢查權限的路由
~~~php
['noAuth2' => true]
~~~
* 在配置文件里面區分了一個功能權限和設備控制的權限,分別存放于兩個不同的數組,要使用按需使用即可
* 權限檢查: 權限檢查文件放在配置文件的同級目錄里面,名稱為 Auth.php
>[info] 權限檢查的時候優先檢查功能權限,對控制設備的權限進行了篩選,要檢查控制設備的路由才進行權限檢查,具體排除,見詳細的 檢查文件。
> 檢查功能權限的時候,通過路由進行匹配出對應的 id 來進行權限檢查。 設備控制檢查通過控制設備參數,多傳遞一個 設備類型來進行權限的精確檢查。也是通過匹配出對應的 id 來進行權限的檢查。
> 檢查功能權限和設備權限的時候,若數據庫里面查詢出的數據,都是空數組的話,表示支持所有的權限,包括功能權限和設備的控制權限。
>[danger] 檢查說明: 設備控制權限,為了節省效率,檢查的時候,只要匹配一個字段有權限就不會再進行下一個字段的權限檢查,也就是說,若同時控制兩個字段,一個有一個沒有權限,檢查出來的權限表示也是有權限的。
## 設備的狀態獲取
* 設備的狀態獲取區分了兩個接口,一個 Api.php 文件來連接和通訊所有的設備相關的功能。
>[danger] 由于設備狀態的實時刷新會影響到前端數據的返回卡頓問題, 特意在后臺獲取到設備狀態之后,存放到數據緩存,默認每個緩存的時間為 60 s ,在設備控制之后進行一個緩存的清除, 設備列表再次請求狀態的時候,默認會從 api 里面獲取最新的設備狀態來及時顯示。 如果離線的話,應該要正常等待 60 s 之后設備狀態才會及時更新。
- 文檔說明
- 更新日志
- Web App 更新日志
- 自用云平臺
- 鑫源云平臺
- 生產管理
- 數據展示平臺
- 云平臺 - v3
- 設備文檔
- KP0C0 - 0 - 0
- KP3C2 - 6 - 1
- K5C2 - 13 - 0
- KP1C2 - 18 - 0
- KP2C4 - 21 - 0
- K5C6 - 25 - 0
- KP5C1 - 27 - 0
- KD5P1 - 29 - 0
- KD5P5 - 46 - 0
- KP1C3 - 47 - 0
- KP1C4 - 48 - 0
- KP1C5 - 49 - 0
- KD4P6 - 53 - 0
- KP3C2 - 65 - 0
- KD5P8 - 72 - 0
- KP2C7 - 75 - 0
- KD5P601 - 76 - 0
- KD5P11 - 79 - 0
- KP01C1510 - 87 - 0
- KP03C0100 - 88 - 0
- KP01C1520 - 90 - 0
- 上報字段
- 數據庫
- 登錄注冊
- 手機注冊
- 郵箱注冊
- 用戶名注冊
- 個人資料
- 管理功能
- 代理相關
- 代理設備
- 授權設備
- 代理功能
- 用戶相關
- 用戶設備
- 用戶分組
- 權限相關
- 設備功能
- 設備分組
- 設備接口
- 數據統計
- 數據統計V2
- 數據統計V3
- 彩云8000 - 數據統計
- 號段申請
- 數據庫
- 登錄注銷
- 申請用戶
- 申請記錄
- 用戶申請
- 文件上傳
- 生產管理
- 登錄注冊
- 提供接口