跳轉到
版本 v1.0.13

HTTPS API

這頁能幫你做什麼

HTTPS API 任務讓工作流程 (Workflow) 呼叫外部的 REST API 或網路服務,把回應帶進後續步驟。常見情境:

  • 串接第三方 SaaS(CRM、金流、分析平台)。
  • 透過 Webhook 送通知(如 Slack、Teams)。
  • 取得外部即時資料(天氣、匯率、股價)。
  • 更新外部系統的記錄(工單、試算表、資料庫)。

開始前

一般呼叫不需前置資源。若要安全存放共用的驗證標頭,可建立一個 HTTP 類型的連結器 (Connector),再於此選用。建立方式見 連結器資源頁

操作步驟

  1. 新增一個 HTTPS API 任務節點,點選它開啟右側設定表單。

    HTTPS API 任務設定面板

  2. 在「名稱」填步驟名稱。

  3. 在「方法」選 HTTP 方法(GET、POST、PUT 等)。
  4. 視需要在「連結器」選一個 HTTP 連結器,套用其共用的驗證標頭。
  5. 在「網址」填目標端點(必須是 https:// 開頭)。
  6. 視需要在「參數」(查詢字串)與「主體」(請求內容)的鍵值表格逐列新增鍵與值。
  7. 視需要展開「進階任務設定」,在「HTTP 標頭」鍵值表格逐列新增標頭。

    HTTPS API 任務展開「進階任務設定」後的「HTTP 標頭」欄位

  8. 設定「下一個狀態」,視需要填「附註」,再用測試按鈕()試跑。

完整欄位說明

下表只列 HTTPS API 任務特有的欄位。名稱、附註、下一個狀態、輸入與輸出、錯誤處理等共用分區,請見 任務通用設定

設定分頁(基本欄位)

欄位 必填 預設 說明
方法 GET HTTP 請求方法,可選 GETPOSTPUTPATCHDELETEHEADOPTIONS
連結器 選一個 HTTP 類型的連結器,套用其共用的驗證標頭到每次請求。可清除、也可從輸入動態帶入。建立方式見 連結器資源頁
網址 https:// 目標 API 端點,必須是 https:// 開頭的合法網址。可用 JSONPath 從輸入帶入,例如 https://api.example.com/users/$.user_id(路徑寫法見 JSONPath 語法)。
參數 空(無查詢參數) 附加在網址後方的查詢字串參數,以鍵值表格逐列新增(每列填鍵與值),常用於篩選、搜尋或分頁。若有設定此欄位,將不接受傳入參數,改用此處的固定值。
主體 空(無主體) 請求主體內容,以鍵值表格逐列新增(每列填鍵與值),適用 POST、PUT 等。若有設定此欄位,將不接受傳入參數,改用此處的固定內容。

進階任務設定(摺疊區塊)

展開設定分頁底部的「進階任務設定」可看到下列欄位:

欄位 必填 預設 說明
HTTP 標頭 空(無自訂標頭) 附加到請求的自訂 HTTP 標頭,以鍵值表格逐列新增(每列填鍵與值),例如內容類型或驗證。若已指定連結器,會與連結器的標頭合併,同名時以此處任務設定為優先。需隱藏敏感資訊時建議改放在連結器。

敏感資訊放連結器

驗證金鑰、Token 等敏感標頭建議放在 HTTP 連結器中,不要直接填在 HTTP 標頭欄位(直接填會以明文儲存)。

執行設定(摺疊區塊)

「設定」分頁底部除「進階任務設定」外,還有一個「執行設定」摺疊區,內含上傳輸出至外部記憶體、即時輸出串流、錯誤時中止等所有任務共用的欄位,完整說明見 任務通用設定

實際範例與預期結果

設定內容:

  • 方法:PUT
  • 網址:https://api.example.com/v1/users/$.user_id
  • HTTP 標頭:Content-Typeapplication/jsonAuthorizationBearer $.api_key
  • 主體:$.user_update

工作流程輸入:

{
  "user_id": "12345",
  "api_key": "your-api-key",
  "user_update": {
    "name": "John Doe",
    "status": "active"
  }
}

測試輸出(API 回應放在 output):

{
  "errors": null,
  "action_type": "https_api_action",
  "output": {
    "id": "12345",
    "name": "John Doe",
    "status": "active"
  }
}

Note

輸出以後端實際回傳為準:API 回應放在 outputaction_type 固定為 https_api_action。回應為 JSON 時 output 是物件或陣列,為純文字時是字串,二進位回應會以 [binary response, N bytes] 形式呈現。後續步驟可用 JSONPath 取值,例如 $.output.id

下一步