API / SDK / developer guide
API authentication
| 目標讀者 TA | API 整合者 |
|---|---|
| 官方文件能力 | 以 API 金鑰認證公開 API。 |
| 輸入 → 輸出 | 含金鑰請求 → 授權資源操作。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 不含免費試用存取；範圍權限依版本而定。 |
| 本站建議驗證 | 測試過期金鑰及拒絕操作，不記錄密鑰。 |
工作流程自動化 · API
n8n Public API
n8n
透過公開 REST API 管理工作流程資源。
免費試用期間無法使用公開 API。實作前選擇符合資格的 Cloud 方案或自管版本，並確認安裝版本。
N8N / DEVELOPER FIELD GUIDE
選對接口，定義可驗證的結果。
公司／專案背景、十個技術入口，以及每份引用的實作分析。
2026-10-08 · 串接尚未實測
公司／專案背景全貌
依官方公司或專案自述撰寫的原創概要；完整原文請見來源。
| 專案 | n8n 自述為 fair-code 流程自動化平台，結合視覺流程與自訂程式。 |
|---|---|
| 部署 | 專案支援自管及雲端部署選擇。 |
| API 範圍 | 公開 REST API 管理支援資源；webhook 業務流程是另一介面選擇。 |
| 適用角色 | 進行 AI 供應商初選的採購、合作夥伴與產品負責人。 |
|---|---|
| 本站評估 | 用定位與公司背景判斷初步適配度；另行取得專案部署、支援與商務條件。 |
已核對官方來源；未執行真實 API、推論或效能測試。預期結果為建議內部契約。
十項技術入口比較
依開發任務選出的十個有文件技術入口；不是十套獨立 SDK 或官方排名。
| 接口 | 用途與 TA |
|---|---|
| 01 · API authenticationAPI / SDK / developer guide | 以 API 金鑰認證公開 API。API 整合者 |
| 02 · API paginationAPI / SDK / developer guide | 遍歷大量資源清單。同步工程師 |
| 03 · Endpoint referenceAPI / SDK / developer guide | 選擇支援的公開 API 操作。後端工程師 |
| 04 · n8n public API CLIAPI / SDK / developer guide | 透過命令列封裝使用公開 API 任務。CI 自動化團隊 |
| 05 · Webhook nodeAPI / SDK / developer guide | 由 HTTP 請求啟動流程處理。流程入口設計者 |
| 06 · Respond to WebhookAPI / SDK / developer guide | 控制流程回傳的 HTTP 回應。API 流程工程師 |
| 07 · HTTP Request nodeAPI / SDK / developer guide | 由流程呼叫外部 HTTP 服務。服務整合團隊 |
| 08 · Error handlingAPI / SDK / developer guide | 明確處理流程執行失敗。可靠性工程師 |
| 09 · Queue modeAPI / SDK / developer guide | 將執行分派至佇列 worker。自管營運團隊 |
| 10 · Workflow data structureAPI / SDK / developer guide | 將流程項目對應至預期資料結構。資料轉換工程師 |
逐份文件分析
能力摘要依據官方文件；限制與建議測試為本站工程評估。
API / SDK / developer guide
API pagination
| 目標讀者 TA | 同步工程師 |
|---|---|
| 官方文件能力 | 遍歷大量資源清單。 |
| 輸入 → 輸出 | 清單請求及游標 → 分頁及下頁游標。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 單一分頁不一定是完整資源清單。 |
| 本站建議驗證 | 檢查空、單頁及多頁結果，避免重複。 |
API / SDK / developer guide
Endpoint reference
| 目標讀者 TA | 後端工程師 |
|---|---|
| 官方文件能力 | 選擇支援的公開 API 操作。 |
| 輸入 → 輸出 | 端點特定請求 → 資源結果。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 不要依賴未文件化編輯器內部端點。 |
| 本站建議驗證 | 依固定版本驗證操作可用性及回應格式。 |
API / SDK / developer guide
n8n public API CLI
| 目標讀者 TA | CI 自動化團隊 |
|---|---|
| 官方文件能力 | 透過命令列封裝使用公開 API 任務。 |
| 輸入 → 輸出 | 指令參數 → API 操作結果。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 仍適用 API 憑證及存取規則。 |
| 本站建議驗證 | 接受 CI 成功前確認目標實例及結束狀態。 |
API / SDK / developer guide
Webhook node
| 目標讀者 TA | 流程入口設計者 |
|---|---|
| 官方文件能力 | 由 HTTP 請求啟動流程處理。 |
| 輸入 → 輸出 | Webhook 請求 → 流程項目及回應。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 測試及正式 webhook URL 生命週期角色不同。 |
| 本站建議驗證 | 檢查正確 URL、認證及重複事件策略。 |
API / SDK / developer guide
Respond to Webhook
| 目標讀者 TA | API 流程工程師 |
|---|---|
| 官方文件能力 | 控制流程回傳的 HTTP 回應。 |
| 輸入 → 輸出 | 流程狀態 → 設定狀態及回應內容。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 提前 HTTP 確認不認證下游完成。 |
| 本站建議驗證 | 測試完成、待完成及錯誤回應契約。 |
API / SDK / developer guide
HTTP Request node
| 目標讀者 TA | 服務整合團隊 |
|---|---|
| 官方文件能力 | 由流程呼叫外部 HTTP 服務。 |
| 輸入 → 輸出 | 設定請求與憑證 → 遠端回應。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 缺少冪等處理時，遠端重試可能重複副作用。 |
| 本站建議驗證 | 驗證逾時、限流及重複提交行為。 |
API / SDK / developer guide
Error handling
| 目標讀者 TA | 可靠性工程師 |
|---|---|
| 官方文件能力 | 明確處理流程執行失敗。 |
| 輸入 → 輸出 | 執行錯誤 → 錯誤流程或受控失敗路徑。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 錯誤後繼續不可誤標整體工作成功。 |
| 本站建議驗證 | 注入失敗相依項並檢查呈現的執行狀態。 |
API / SDK / developer guide
Queue mode
| 目標讀者 TA | 自管營運團隊 |
|---|---|
| 官方文件能力 | 將執行分派至佇列 worker。 |
| 輸入 → 輸出 | 已接受執行 → 佇列 worker 處理。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 進入佇列不代表完成；須設定共用基礎設施。 |
| 本站建議驗證 | 測試 worker 不可用、重試及結果可見性。 |
API / SDK / developer guide
Workflow data structure
| 目標讀者 TA | 資料轉換工程師 |
|---|---|
| 官方文件能力 | 將流程項目對應至預期資料結構。 |
| 輸入 → 輸出 | 含 JSON／二進位資料的項目陣列 → 下游節點輸入。 |
| 執行環境 | 固定 n8n 實例；明確選定 Cloud 方案或自管版本 |
| 本站選型評估 | 零項目與單一空 JSON 項目不同。 |
| 本站建議驗證 | 轉換後測試項目数、欄位型別及二進位參照。 |
Public API overview
| TA | 產品及整合負責人 |
|---|---|
| 本站驗證建議 | 檢查選定方案 API 可用性，並區分 REST、CLI 與 webhook。 |
04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE
實作前先看懂預期結果
流程執行收據示意，不是公開 API 原生格式。未執行 webhook、流程、外部 API 或部署。
示意契約 · 未呼叫 API 或執行模型 · 不是供應商實測輸出
完成轉換
| 輸入 | 含必要零件欄位的有效流程項目。 |
|---|---|
| 預期結果 | ok，含執行 ID 及正規化輸出項目。 |
| 驗收條件 | 確認終態成功及預期項目數。 |
篩選後空輸出
| 輸入 | 所有項目均未通過宣告篩選。 |
|---|---|
| 預期結果 | ok 且 output_items: []；無外部操作。 |
| 驗收條件 | 區分零項目與內容為空物件的單項目。 |
已接受但排隊中
| 輸入 | Webhook 已確認但 worker 尚待執行。 |
|---|---|
| 預期結果 | pending 與執行 ID；無已完成業務結果。 |
| 驗收條件 | 只在執行到達終態後標記完成。 |
相依服務失敗
| 輸入 | 遠端服務逾時或拒絕憑證。 |
|---|---|
| 預期結果 | error／partial 與失敗節點資訊，不假稱送達。 |
| 驗收條件 | 有副作用操作採有限重試及冪等處理。 |
將預期結果對應至你的應用
整合後將實際 SDK 或服務回應對應至此建議內部契約。下列識別碼與數值均為示意；不含憑證或真實請求。
預期輸出 JSON — 示意，非實測 · n8nAPI-expected-results.json
{
"schema_version": "1.0.0",
"example": true,
"provider": "n8n",
"status": "ok",
"input_id": "sample-001",
"data": {
"workflow_id": "example-workflow",
"execution_id": "example-execution",
"execution_status": "completed",
"output_items": [
{
"part_id": "example-part",
"route": "review"
}
],
"external_action_confirmed": false
},
"error": null,
"verification": "illustrative-only;not-provider-response"
}| 結果解讀 | 傳輸或執行成功不代表模型準確。有效空結果須與操作失敗分開。 |
|---|---|
| 可重現性 | 記錄模型、環境、設定與輸入識別；代表性測試前約定品質及延遲條件。不宣稱已實測效能。 |
| 操作範圍 | 流程執行收據示意，不是公開 API 原生格式。未執行 webhook、流程、外部 API 或部署。 |
開發評估
RFQ 收件整理流程
開發構想規格・串接尚未實測
接口能力依據官方文件或程式庫；以下產品方向、輸入、交付與驗收條件則是我們的開發評估。
可先做小原型
確認存取後，用少量真實樣本測試一個有文件的操作。此為開發判斷，不是交期估算。
- 原型輸入規劃
- 一筆範例事件、經授權系統與一個明確流程轉換。
- 原型交付規劃
- 單一流程的可見工作狀態與操作紀錄。
- 驗收條件
- 重送事件不得重複建立工作；上游不可用時需保留等待或失敗狀態。
- 依賴條件
- 執行環境存取、流程權限與已核對的通知或寫入目的地。
串接前置條件
免費試用期間無法使用公開 API。實作前選擇符合資格的 Cloud 方案或自管版本，並確認安裝版本。
開發順序
- 確認 n8n Public API 的存取、授權與支援版本。
- 準備上述樣本，針對「RFQ 收件整理流程」先實作一個有官方文件的操作。
- 整理輸出時保留來源、時間與錯誤狀態，並保留供應商回應供審核。
- 通過驗收條件後，再估算擴展投入與客戶交付。
如何驗證需求
記錄產品瀏覽、官方文件點擊、規格下載與技術 Hub 點擊。這些是事件次數，不等於獨立人數或已完成串接。
本次可行性評估依實作條件判斷；尚未給定流量排名或交期承諾。