API / SDK / developer guide
Admin HTTP API
| 目標讀者 TA | 環境管理者 |
|---|---|
| 官方文件能力 | 遠端讀取或管理執行環境設定。 |
| 輸入 → 輸出 | 授權管理請求 → 設定回應。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 管理端點控制環境，不是一般流程業務輸出。 |
| 本站建議驗證 | 變更前驗證認證及部署修訂。 |
工作流程自動化 · API / SDK
Node-RED APIs
OpenJS Foundation
透過官方 API 管理自動化執行環境並擴充行為。
NODE-RED / DEVELOPER FIELD GUIDE
選對接口，定義可驗證的結果。
公司／專案背景、十個技術入口，以及每份引用的實作分析。
2026-10-08 · 串接尚未實測
公司／專案背景全貌
依官方公司或專案自述撰寫的原創概要；完整原文請見來源。
| 專案 | Node-RED 是最初由 IBM 開發、現屬 OpenJS Foundation 的流程式程式工具。 |
|---|---|
| 架構 | 瀏覽器編輯器將節點連成在 Node.js 執行的事件驅動應用。 |
| 重用 | 流程使用 JSON 分享；社群節點可擴充功能，但須個別審查。 |
| 適用角色 | 進行 AI 供應商初選的採購、合作夥伴與產品負責人。 |
|---|---|
| 本站評估 | 用定位與公司背景判斷初步適配度；另行取得專案部署、支援與商務條件。 |
已核對官方來源；未執行真實 API、推論或效能測試。預期結果為建議內部契約。
十項技術入口比較
依開發任務選出的十個有文件技術入口；不是十套獨立 SDK 或官方排名。
| 接口 | 用途與 TA |
|---|---|
| 01 · Admin HTTP APIAPI / SDK / developer guide | 遠端讀取或管理執行環境設定。環境管理者 |
| 02 · Hooks APIAPI / SDK / developer guide | 在有文件的執行掛鉤插入程式。環境擴充工程師 |
| 03 · Storage APIAPI / SDK / developer guide | 替换執行環境儲存實作。持久儲存實作者 |
| 04 · LoggingAPI / SDK / developer guide | 設定執行日誌及自訂目的地。營運團隊 |
| 05 · Context Store APIAPI / SDK / developer guide | 為節點、流程及全域 context 提供自訂儲存。有狀態流程工程師 |
| 06 · Library Store APIAPI / SDK / developer guide | 新增匯入／匯出函式庫後端。共用函式庫維護者 |
| 07 · Editor APIsAPI / SDK / developer guide | 使用支援的編輯器元件及擴充 API。自訂節點 UI 工程師 |
| 08 · Module APIsAPI / SDK / developer guide | 將 Node-RED 模組嵌入 Node.js 應用。嵌入應用團隊 |
| 09 · Writing FunctionsAPI / SDK / developer guide | 以 JavaScript 轉換及路由訊息物件。流程邏輯工程師 |
| 10 · Creating NodesAPI / SDK / developer guide | 封裝可重用執行及編輯功能。節點套件作者 |
逐份文件分析
能力摘要依據官方文件；限制與建議測試為本站工程評估。
API / SDK / developer guide
Hooks API
| 目標讀者 TA | 環境擴充工程師 |
|---|---|
| 官方文件能力 | 在有文件的執行掛鉤插入程式。 |
| 輸入 → 輸出 | 執行事件 → 擴充行為。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 掛鉤可能影響訊息處理，不可靜默遺失工作。 |
| 本站建議驗證 | 以可關聯訊息測試成功及例外路徑。 |
API / SDK / developer guide
Storage API
| 目標讀者 TA | 持久儲存實作者 |
|---|---|
| 官方文件能力 | 替换執行環境儲存實作。 |
| 輸入 → 輸出 | 環境狀態 → 持久化及復原資料。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 後端失敗不可回報為成功持久儲存。 |
| 本站建議驗證 | 重新啟動並驗證流程及必要設定復原。 |
API / SDK / developer guide
Logging
| 目標讀者 TA | 營運團隊 |
|---|---|
| 官方文件能力 | 設定執行日誌及自訂目的地。 |
| 輸入 → 輸出 | 執行事件 → 日誌項目。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 除錯內容可能含敏感資料，需明確政策。 |
| 本站建議驗證 | 驗證錯誤可見性，收集前遮蔽憑證。 |
API / SDK / developer guide
Context Store API
| 目標讀者 TA | 有狀態流程工程師 |
|---|---|
| 官方文件能力 | 為節點、流程及全域 context 提供自訂儲存。 |
| 輸入 → 輸出 | Context 讀寫 → 範圍內值。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 儲存實作可能不同步或非同步存取。 |
| 本站建議驗證 | 檢查缺少鍵、寫入錯誤及重啟持久性。 |
API / SDK / developer guide
Library Store API
| 目標讀者 TA | 共用函式庫維護者 |
|---|---|
| 官方文件能力 | 新增匯入／匯出函式庫後端。 |
| 輸入 → 輸出 | 函式庫查詢／儲存 → 可重用流程內容。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 儲存流程憑證及環境相依項須另行處理。 |
| 本站建議驗證 | 樣本匯入匯出往返，確認共用匯出不含密鑰。 |
API / SDK / developer guide
Editor APIs
| 目標讀者 TA | 自訂節點 UI 工程師 |
|---|---|
| 官方文件能力 | 使用支援的編輯器元件及擴充 API。 |
| 輸入 → 輸出 | 編輯器輸入 → 節點設定。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 編輯器驗證不能取代執行輸入驗證。 |
| 本站建議驗證 | 檢查設定儲存／重開及錯誤輸入回饋。 |
API / SDK / developer guide
Module APIs
| 目標讀者 TA | 嵌入應用團隊 |
|---|---|
| 官方文件能力 | 將 Node-RED 模組嵌入 Node.js 應用。 |
| 輸入 → 輸出 | 主應用設定 → 嵌入環境。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 須協調主應用生命週期與環境啟停。 |
| 本站建議驗證 | 測試啟動失敗及正常結束，避免重複監聽器。 |
API / SDK / developer guide
Writing Functions
| 目標讀者 TA | 流程邏輯工程師 |
|---|---|
| 官方文件能力 | 以 JavaScript 轉換及路由訊息物件。 |
| 輸入 → 輸出 | msg 物件 → 零、一或多個下游訊息。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 回傳 null 會刻意停止傳遞；新物件可能遺失 req／res 欄位。 |
| 本站建議驗證 | 保留關聯及必要欄位；明確完成非同步工作。 |
API / SDK / developer guide
Creating Nodes
| 目標讀者 TA | 節點套件作者 |
|---|---|
| 官方文件能力 | 封裝可重用執行及編輯功能。 |
| 輸入 → 輸出 | 節點定義及訊息 → 可重用處理節點。 |
| 執行環境 | 固定 Node-RED 與支援 Node.js 環境 |
| 本站選型評估 | 第三方相依項需版本及環境相容審查。 |
| 本站建議驗證 | 測試部署、訊息處理及關閉清理。 |
API reference
| TA | 整合架構師 |
|---|---|
| 本站驗證建議 | 明確選擇管理、環境擴充或流程訊息介面。 |
04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE
實作前先看懂預期結果
建議流程訊息處理收據，不是 Node-RED 管理 API 輸出。未部署流程、傳送訊息或觸發外部系統。
示意契約 · 未呼叫 API 或執行模型 · 不是供應商實測輸出
訊息已轉換
| 輸入 | 含數值溫度及關聯 ID 的授權樣本。 |
|---|---|
| 預期結果 | ok 與一則正規化下游訊息。 |
| 驗收條件 | 保留關聯及單位；驗證預期輸出恰好一次。 |
刻意篩除
| 輸入 | 訊息未通過宣告篩選，Function 回傳 null。 |
|---|---|
| 預期結果 | 本站收據為 ok／filtered，output_count: 0。 |
| 驗收條件 | 區分刻意篩除、當機及未連接節點。 |
非同步待完成
| 輸入 | 節點啟動外部非同步操作。 |
|---|---|
| 預期結果 | 完成前為 pending；不提前確認送達。 |
| 驗收條件 | 完成路徑僅一次，並採有限逾時政策。 |
無效訊息
| 輸入 | 內容單位錯誤或缺少必要值。 |
|---|---|
| 預期結果 | error 送往明確處理；無下游操作。 |
| 驗收條件 | 帶關聯捕捉錯誤；除錯日誌不可洩漏憑證。 |
將預期結果對應至你的應用
整合後將實際 SDK 或服務回應對應至此建議內部契約。下列識別碼與數值均為示意；不含憑證或真實請求。
預期輸出 JSON — 示意，非實測 · NodeREDAPI-expected-results.json
{
"schema_version": "1.0.0",
"example": true,
"provider": "Node-RED",
"status": "ok",
"input_id": "sample-001",
"data": {
"flow_id": "example-flow",
"message_id": "example-message",
"output_count": 1,
"payload": {
"temperature_c": 24
},
"side_effect_confirmed": false
},
"error": null,
"verification": "illustrative-only;not-provider-response"
}| 結果解讀 | 傳輸或執行成功不代表模型準確。有效空結果須與操作失敗分開。 |
|---|---|
| 可重現性 | 記錄模型、環境、設定與輸入識別；代表性測試前約定品質及延遲條件。不宣稱已實測效能。 |
| 操作範圍 | 建議流程訊息處理收據，不是 Node-RED 管理 API 輸出。未部署流程、傳送訊息或觸發外部系統。 |
開發評估
工廠事件通知流程
開發構想規格・串接尚未實測
接口能力依據官方文件或程式庫；以下產品方向、輸入、交付與驗收條件則是我們的開發評估。
可先做小原型
確認存取後，用少量真實樣本測試一個有文件的操作。此為開發判斷，不是交期估算。
- 原型輸入規劃
- 一筆範例事件、經授權系統與一個明確流程轉換。
- 原型交付規劃
- 單一流程的可見工作狀態與操作紀錄。
- 驗收條件
- 重送事件不得重複建立工作；上游不可用時需保留等待或失敗狀態。
- 依賴條件
- 執行環境存取、流程權限與已核對的通知或寫入目的地。
開發順序
- 確認 Node-RED APIs 的存取、授權與支援版本。
- 準備上述樣本，針對「工廠事件通知流程」先實作一個有官方文件的操作。
- 整理輸出時保留來源、時間與錯誤狀態，並保留供應商回應供審核。
- 通過驗收條件後，再估算擴展投入與客戶交付。
如何驗證需求
記錄產品瀏覽、官方文件點擊、規格下載與技術 Hub 點擊。這些是事件次數，不等於獨立人數或已完成串接。
本次可行性評估依實作條件判斷；尚未給定流量排名或交期承諾。