API / SDK / developer guide
REST API and OpenAPI
| 目標讀者 TA | 自動化開發者 |
|---|---|
| 官方文件能力 | 檢視部署 API 結構並自動化代理管理。 |
| 輸入 → 輸出 | 版本化管理請求 → JSON／狀態。 |
| 執行環境 | API 金鑰／密鑰或 bearer 權杖；已部署功能集。 |
| 本站選型評估 | 6.3 移除內建 Swagger UI；停用功能的 API 路徑不會載入。 |
| 本站建議驗證 | 讀取安裝版本結構；不可用 Dashboard 密碼直接作 API Basic 憑證。 |
工業 IoT／SCADA · API
EMQX REST API
EMQ
透過官方 REST 接口管理 MQTT broker 資源。
EMQX / DEVELOPER FIELD GUIDE
選對接口，定義可驗證的結果。
公司／專案背景、十個技術入口，以及每份引用的實作分析。
2026-10-08 · 串接尚未實測
公司／專案背景全貌
依官方公司或專案自述撰寫的原創概要；完整原文請見來源。
| 公司與專案 | EMQ 開發 MQTT 連線與即時資料基礎設施；EMQX 是其代理平台。 |
|---|---|
| 版本與產品層級 | 這些現行 Enterprise 文件入口需匹配部署版本、授權功能與功能開關；並非十套獨立 SDK。 |
| 適用角色 | 進行 AI 供應商初選的採購、合作夥伴與產品負責人。 |
|---|---|
| 本站評估 | 用定位與公司背景判斷初步適配度；另行取得專案部署、支援與商務條件。 |
已核對官方來源。未呼叫供應商 API 或執行推論；結果為內部契約示意。
十項技術入口比較
依實作決策選出的十個技術文件入口，非十套獨立 SDK 或官方排名。
| 接口 | 用途與 TA |
|---|---|
| 01 · REST API and OpenAPIAPI / SDK / developer guide | 檢視部署 API 結構並自動化代理管理。自動化開發者 |
| 02 · Client/session inspectionAPI / SDK / developer guide | 檢視連線與未到期工作階段。維運工程師 |
| 03 · Subscription inspectionAPI / SDK / developer guide | 檢視用戶端／主題／QoS 與 MQTT5 訂閱選項。MQTT 整合者 |
| 04 · Retained message managementAPI / SDK / developer guide | 檢視儲存的保留主題內容。裝置狀態消費端 |
| 05 · MQTT authenticationAPI / SDK / developer guide | 透過設定的認證器驗證用戶端身分。裝置安全開發者 |
| 06 · MQTT authorizationAPI / SDK / developer guide | 依用戶端與主題管控發布／訂閱操作。租戶隔離團隊 |
| 07 · Rules and actionsAPI / SDK / developer guide | 透過類 SQL 規則與動作轉換／過濾資料。管線開發者 |
| 08 · Prometheus metricsAPI / SDK / developer guide | 以拉取或推送整合蒐集執行指標。SRE 團隊 |
| 09 · Filtered log traceAPI / SDK / developer guide | 追蹤指定用戶端、主題、IP 或規則。疑難排解工程師 |
| 10 · gRPC hook extensionAPI / SDK / developer guide | 透過外部語言服務處理代理事件。擴充開發者 |
逐份文件分析
能力摘要依據官方文件；限制與建議測試為本站工程評估。
API / SDK / developer guide
Client/session inspection
| 目標讀者 TA | 維運工程師 |
|---|---|
| 官方文件能力 | 檢視連線與未到期工作階段。 |
| 輸入 → 輸出 | 用戶端篩選 → 連線／工作階段細節。 |
| 執行環境 | 授權 Dashboard 或相符部署 API。 |
| 本站選型評估 | 保留工作階段不代表用戶端在線。 |
| 本站建議驗證 | 計數前檢查連線狀態與完整分頁。 |
API / SDK / developer guide
Subscription inspection
| 目標讀者 TA | MQTT 整合者 |
|---|---|
| 官方文件能力 | 檢視用戶端／主題／QoS 與 MQTT5 訂閱選項。 |
| 輸入 → 輸出 | 用戶端／主題查詢 → 訂閱項目。 |
| 執行環境 | 相符代理版本與用戶端 MQTT 版本。 |
| 本站選型評估 | 訂閱存在並非應用端接收證據。 |
| 本站建議驗證 | 依需求驗證 No Local 與保留訊息處理。 |
API / SDK / developer guide
Retained message management
| 目標讀者 TA | 裝置狀態消費端 |
|---|---|
| 官方文件能力 | 檢視儲存的保留主題內容。 |
| 輸入 → 輸出 | 主題選擇 → 內容、QoS 與發布時間。 |
| 執行環境 | 保留器設定與管理權限。 |
| 本站選型評估 | 保留資料可能過時；不是完整訊息歷程。 |
| 本站建議驗證 | 顯示即時狀態前核對發布時間與到期政策。 |
API / SDK / developer guide
MQTT authentication
| 目標讀者 TA | 裝置安全開發者 |
|---|---|
| 官方文件能力 | 透過設定的認證器驗證用戶端身分。 |
| 輸入 → 輸出 | 用戶端憑證 → 認證結果。 |
| 執行環境 | 設定憑證／密碼／JWT 或支援機制。 |
| 本站選型評估 | 不可假設預設已啟用認證。 |
| 本站建議驗證 | 驗證有效憑證及明確拒絕無效用戶端。 |
API / SDK / developer guide
MQTT authorization
| 目標讀者 TA | 租戶隔離團隊 |
|---|---|
| 官方文件能力 | 依用戶端與主題管控發布／訂閱操作。 |
| 輸入 → 輸出 | 身分／主題／操作 → 允許或拒絕。 |
| 執行環境 | 設定權限來源與適用快取行為。 |
| 本站選型評估 | 認證成功不代表授權所有主題。 |
| 本站建議驗證 | 核對跨租戶主題、QoS 與保留訊息權限。 |
API / SDK / developer guide
Rules and actions
| 目標讀者 TA | 管線開發者 |
|---|---|
| 官方文件能力 | 透過類 SQL 規則與動作轉換／過濾資料。 |
| 輸入 → 輸出 | 訊息事件與規則 → 動作或重新發布內容。 |
| 執行環境 | 啟用規則引擎與設定連接器／動作。 |
| 本站選型評估 | 規則符合不代表目的端已提交。 |
| 本站建議驗證 | 分別驗證轉換內容與寫入端結果。 |
API / SDK / developer guide
Prometheus metrics
| 目標讀者 TA | SRE 團隊 |
|---|---|
| 官方文件能力 | 以拉取或推送整合蒐集執行指標。 |
| 輸入 → 輸出 | 設定蒐集 → 指標時序資料。 |
| 執行環境 | 6.3 的 metrics 功能開關及 dashboard 相依。 |
| 本站選型評估 | 推送模式不同於完整拉取指標集。 |
| 本站建議驗證 | 核對目標版本的指標可用性與樣本新鮮度。 |
API / SDK / developer guide
Filtered log trace
| 目標讀者 TA | 疑難排解工程師 |
|---|---|
| 官方文件能力 | 追蹤指定用戶端、主題、IP 或規則。 |
| 輸入 → 輸出 | 追蹤條件 → 符合的診斷事件。 |
| 執行環境 | 授權追蹤與有限保留期限。 |
| 本站選型評估 | 無符合事件可能是篩選錯誤或沒有流量。 |
| 本站建議驗證 | 以已知事件驗證涵蓋範圍；遮蔽敏感內容。 |
API / SDK / developer guide
gRPC hook extension
| 目標讀者 TA | 擴充開發者 |
|---|---|
| 官方文件能力 | 透過外部語言服務處理代理事件。 |
| 輸入 → 輸出 | EMQX hook → gRPC 伺服器回呼回應。 |
| 執行環境 | Exhook 設定與相容回呼結構。 |
| 本站選型評估 | 外部服務行為成為設定 hook 的相依因素。 |
| 本站建議驗證 | 測試處理器停機、逾時及串接回呼行為。 |
Official documentation
| TA | 工程師與技術產品負責人 |
|---|---|
| 本站驗證建議 | 實作前固定版本並依目標環境核對支援條件。 |
04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE
實作前先看懂預期結果
代理觀察契約示意；未使用代理、MQTT 流量或管理 API。
示意契約 · 未呼叫 API 或執行模型 · 不是供應商實測輸出
關聯傳送
| 輸入 | 已知用戶端與主題的合成事件。 |
|---|---|
| 預期結果 | 代理事件與消費端事件具有相同應用事件 ID。 |
| 驗收條件 | 不可用 connected=true 替代傳送證據。 |
無符合用戶端
| 輸入 | 授權篩選查詢無符合的活躍用戶端。 |
|---|---|
| 預期結果 | clients=[] 並保留查詢範圍。 |
| 驗收條件 | 區分空篩選結果與整個代理停機。 |
管理憑證到期
| 輸入 | 以到期 bearer 權杖送 REST 請求。 |
|---|---|
| 預期結果 | 認證錯誤；無管理結果。 |
| 驗收條件 | 透過授權流程更新，不記錄密鑰。 |
功能 API 不可用
| 輸入 | 呼叫目標為安裝功能集中停用的路徑。 |
|---|---|
| 預期結果 | 分類為不支援／停用功能；不是空成功。 |
| 驗收條件 | 修改整合前比較安裝 API 結構與功能集。 |
將預期結果對應至你的應用
將實際執行環境回應對應至此建議應用契約。所有數值皆為示意，不含憑證或真實執行。
預期輸出 JSON — 示意，非實測 · EMQXAPI-expected-results.json
{
"schema_version": "1.0.0",
"example": true,
"provider": "EMQX",
"status": "ok",
"input_id": "sample-001",
"data": {
"client_id": "demo-client-001",
"connected": true,
"topic": "demo/telemetry",
"consumer_observed": true,
"retained_payload_is_live": false
},
"error": null,
"verification": "illustrative-only;not-provider-response"
}| 狀態語意 | 有效空結果與錯誤不同；等待中的工作不可提前顯示成功。 |
|---|---|
| 證據 | 記錄服務與 SDK 版本、請求識別、設定及回應映射。此處未執行或量測效能。 |
| 建議驗收 | 以授權代表樣本測試前，先約定數值誤差與負載目標。 |
開發評估
MQTT 裝置群健康看板
開發構想規格・串接尚未實測
接口能力依據官方文件或程式庫；以下產品方向、輸入、交付與驗收條件則是我們的開發評估。
可先做小原型
確認存取後，用少量真實樣本測試一個有文件的操作。此為開發判斷，不是交期估算。
- 原型輸入規劃
- 測試設備或模擬器、訊號對照表與明確單位。
- 原型交付規劃
- 附時間、資料新鮮度、單位與連線狀態的設備數值。
- 驗收條件
- 對照來源驗證比例與時間；設備斷線時不得顯示正常。
- 依賴條件
- 閘道或服務帳號、設備資料結構與測試環境。
開發順序
- 確認 EMQX REST API 的存取、授權與支援版本。
- 準備上述樣本，針對「MQTT 裝置群健康看板」先實作一個有官方文件的操作。
- 整理輸出時保留來源、時間與錯誤狀態，並保留供應商回應供審核。
- 通過驗收條件後，再估算擴展投入與客戶交付。
如何驗證需求
記錄產品瀏覽、官方文件點擊、規格下載與技術 Hub 點擊。這些是事件次數，不等於獨立人數或已完成串接。
本次可行性評估依實作條件判斷；尚未給定流量排名或交期承諾。