差異處

這裏顯示兩個版本的差異處。

--- public:fronteco:api [2025/04/22 10:46] – chrishuang
+++ public:fronteco:api [2025/04/25 15:32] (目前版本) – [回應內容] liangyu
@@ 行 24: / 行 24: @@
 ^ 動作              ^ 方法                         ^ 路徑                            ^ 說明                                                    ^
 | 取得裝置列表      | <color #b5e61d>GET</color>   | ''/devices''             | 使用複數命名，代表裝置資源集合                          |
-| 取得某裝置的資料  | <color #b5e61d>GET</color>   | ''/devices/{deviceId}''  | 取得特定裝置（依據 deviceId）之詳細資料                 |
+| 取得有效電能的裝置資料  | <color #b5e61d>GET</color>   | ''/devices/kwh''  | 取得特定裝置（依據 deviceId）之詳細資料                 |
+| 取得有效電能日期區間的裝置資料  | <color #b5e61d>GET</color>   | ''/devices/kwh/dateRange''  | 取得特定裝置（依據 deviceId、日期區間）之詳細資料，限制數量三個月資料(每15分鐘裡最大值)                 |
+| 取得溫、濕度的裝置資料  | <color #b5e61d>GET</color>   | ''/devices/temperature''  | 取得特定裝置（依據 deviceId）之詳細資料                 |
+| 取得溫、濕度日期區間的裝置資料  | <color #b5e61d>GET</color>   | ''/devices/temperature/dateRange''  | 取得特定裝置（依據 deviceId、日期區間）之詳細資料，限制數量三個月資料(每15分鐘裡最大值)                 |
 | 新增計算後資料數據 | <color #ff7f27>POST</color>  | ''/calculations''        | 將資料上傳至指定裝置，通常為裝置運算後需回傳的結果資料 |
@@ 行 32: / 行 35: @@
   * x-api-key：''由 EMS 提供授權碼''
-==== 查詢參數 ====
+==== 傳遞參數 ====
 ^ 欄位      ^ 格式      ^ 必填  ^ 說明                          ^
 | deviceId  | String     | Required  | 裝置唯一識別碼                |
@@ 行 38: / 行 41: @@
 | endTime   | Datetime   | Optional  | 資料結束時間 (2025-05-18)     |
+==== JSON ====
+<code javascript>
+{
+    "deviceId": "device-002",
+    "startTime": "2025-04-01 00:00:00",
+    "endTime": "2025-04-31 23:59:59"
+}
+</code>
 ==== 回應參數 ====
 ^ 參數          ^ 型別    ^ 說明                   ^
@@ 行 56: / 行 67: @@
 | kWh                                 | Decimal  | 每小時瓩               |
+'' GET /devices/kwh ''
 ==== 回應內容 ====
-<code javascript>
+<code javascript 電錶>
-[
+{
-  {
+  "deviceId": "device-002",
-    "deviceId": "device-001",
+  "deviceStatus": "off",
-    "deviceStatus": "on",
+  "timestamp": "2025-04-01T00:00:00+08:00",
-    "timestamp": "2025-04-01T00:00:00+08:00",
+  "rawData": {
-    "rawData": {
+    "kWh": 14257.231
-      "temperature": 26.4,
+  }
-      "humidity": 83.1
+}
+</code>
+'' GET /devices/temperature ''
+<code javascript 溫溼度感測器>
+{
+  "deviceId": "device-001",
+  "deviceStatus": "on",
+  "timestamp": "2025-04-01T00:00:00+08:00",
+  "rawData": {
+    "temperature": 26.4,
+    "humidity": 83.1
+  }
+}
+</code>
+'' GET /devices/kwh/dateRange ''
+<code javascript 電錶(日期區間多筆資料)>
+{
+  "deviceId": "device-002",
+  "deviceStatus": "off",
+  "timestamp": "2025-04-01T00:00:00+08:00",
+  "rawData": {
+    "kWh": {
+      "1745481208": 14241.231,
+      "1745481213": 14244.231,
+      "1745481219": 14248.231,
+      "1745481226": 14250.231,
+      "1745481230": 14253.231,
+      "1745481237": 14257.231
     }
-  },
+  }
-  {
+}
-    "deviceId": "device-002",
+</code>
-    "deviceStatus": "off",
-    "timestamp": "2025-04-01T00:00:00+08:00",
-    "rawData": {
+'' GET /devices/temperature/dateRange ''
-      "kWh": 14257.231
+<code javascript 溫溼度感測器(日期區間多筆資料)>
+{
+  "deviceId": "device-001",
+  "deviceStatus": "on",
+  "timestamp": "2025-04-01T00:00:00+08:00",
+  "rawData": {
+    "temperature": {
+      "1745481315": 25.12,
+      "1745481319": 25.0,
+      "1745481324": 25.06,
+      "1745481329": 25.0,
+      "1745481334": 24.87,
+      "1745481340": 25.18
+    },
+    "humidity": {
+      "1745481315": 78.12,
+      "1745481319": 81.0,
+      "1745481324": 84.06,
+      "1745481329": 80.0,
+      "1745481334": 76.87,
+      "1745481340": 74.18
     }
   }
-]
+}
 </code>
@@ 行 122: / 行 185: @@
 </code>
-===== 錯誤代碼與說明（Error Codes） =====
+===== 錯誤代碼與說明 =====
 ^ 錯誤代碼          ^ 錯誤訊息                          ^
 | UNAUTHORIZED      | API 金鑰無效或未授權              |