跳至主要内容

HTTP Request

HTTP Request 是用於透過 HTTP 請求呼叫外部 API 的 processor。

基本用法

執行 HTTP Request 時,會依據設定的 URL、HTTP 方法、請求標頭和內容發送請求,並將回應結果儲存到 httpResponse 變數中供後續 processor 使用。適用於資料整合、第三方服務串接、Webhook 觸發、外部驗證等需要與外部系統互動的場景。

配置參數

Name

顯示在畫布上的名稱,用於在工作流程中識別此 processor。

Description

用於補充此 processor 的用途,提升工作流程的可讀性。

Properties

URL(必填)

要發送請求的目標網址。支援 Literal、Expression、Template、Template (Advance) 等設定類型,詳細說明請參考:Expression 介紹 - 取值方式

Method(必填)

HTTP 請求方法,支援 GET、POST、PUT、DELETE、PATCH 等方法。

Parse JSON(必填)

是否自動解析 JSON 格式的回應內容,預設值為關閉。開啟後,httpResponse 物件會包含額外的 json 欄位。

Body

請求內容,通常用於 POST、PUT 等需要傳送資料的請求。支援 Literal、Expression、Template 等設定類型,詳細說明請參考:Expression 介紹 - 取值方式

額外的 HTTP 請求標頭。可新增多個標頭項目,常用於 Authorization、Content-Type 等設定。

連接關係

Success

當 HTTP 請求的回應狀態碼為 200 時,工作流程會從此連接點繼續執行。會產生 httpResponse 變數包含以下欄位:

欄位類型說明
statusCodenumberHTTP 狀態碼
bodystring回應內容(原始字串)
jsonobject解析後的 JSON 物件(當 Parse JSON 開啟時)
headersobject回應標頭物件

Failure

當 HTTP 請求失敗(非 200 狀態碼)或發生網路錯誤時,工作流程會從此連接點繼續執行,並產生 prevError 變數儲存錯誤資訊。

使用範例

取得外部資料


使用 GET 方法呼叫外部 API 取得資料。設定 URL 為目標 API 位址,開啟 Parse JSON 自動解析回應內容,然後透過 Push Message 將結果呈現給使用者。

動態 URL 請求


根據使用者輸入動態組合 URL 進行 API 呼叫。URL 設定使用 Expression(例如:'https://dummyjson.com/todos/' + prevMessage)來組合完整的 API 網址。

POST 請求提交資料


使用 POST 方法提交資料到外部 API。Body 使用 Expression 動態組合 JSON 資料(例如:JSON.stringify({name: userName, email: userEmail})),並設定適當的 Additional HTTP Headers 如 Content-Type 和 Authorization。

處理 API 回應


處理和格式化 API 回應資料。Push Message 使用 Expression 功能檢查 httpResponse.json 內容並格式化輸出訊息,確保回應資料以易讀的方式呈現給使用者。

條件式錯誤處理


分別處理 API 呼叫的成功和失敗情況。Success 分支處理正常回應,Failure 分支使用 prevError 變數顯示錯誤訊息,確保使用者能了解請求失敗的原因。

注意事項

  1. 確保 URL 格式正確,包含完整的協定(http:// 或 https://)。

  2. 妥善設定 API 金鑰或認證資訊,避免洩露敏感資料。

  3. POST/PUT 請求時注意 Content-Type 標頭與 Body 格式的一致性。

  4. 建議連接 Failure 分支,處理網路錯誤或 API 回應錯誤。

  5. 外部 API 呼叫可能較慢,考慮設定適當的超時時間。

  6. 開啟 Parse JSON 時,確保 API 回應確實為有效的 JSON 格式。

  7. 只有 HTTP 狀態碼 200 才會進入 Success 分支,其他狀態碼都會進入 Failure 分支。