REST Services

REST Services 為 API 服務類型的 Action,可透過 GET 呼叫外部 REST API,取得 JSON 回應內容。依照設定的傳回型別,可回傳單筆多筆資料,並可搭配 Assign Variables 將回傳結果傳出,進一步用於欄位的動態初值動態清單等情境。

此章節包含的主題:

設定前檢查

在設定 REST Services 之前,建議先確認要呼叫的 API 服務可正常回應,避免流程設計完成後才發現 API 無法使用。

  1. 先使用瀏覽器或 API 測試工具(如 Postman)直接呼叫 API,確認可回傳 JSON 格式內容。

  2. 確認要回傳的資料型態:若回傳為單一物件請使用單筆;若回傳為陣列清單請使用多筆

  3. 本頁示範使用 GET 呼叫 API;若需帶入條件參數,請於 Params 分頁新增鍵值。

REST Services 屬性

REST Services屬性頁籤用來設定 API 呼叫方式、傳回型別與參數等資訊。

REST Services 屬性頁籤(Params/Headers/Body/Authorization)

主要欄位與功能說明如下:

輸出設定

輸出頁籤可用來啟用此 Action 的輸出,並設定輸出名稱,方便在流程或資料規格中引用。

REST Services 輸出設定

說明

說明頁籤可用來輸入備註或補充資訊,方便日後維護流程時快速了解此 Action 的用途。系統在流程畫面顯示提示時,會優先顯示此處內容;若未填寫,則通常會以標題作為提示文字。

REST Services 說明頁籤

測試與回應結果

在屬性頁籤完成設定後,可點選右側的測試按鈕,系統會立即呼叫 API 並顯示回應結果,用來確認 URL、參數與回傳內容是否正確。

點選測試並檢視回應結果

確認回應內容無誤後,即可按關閉返回設定畫面,並按右下角確定完成此 Action 設定。

範例1:回傳單筆,作為動態初值

此範例示範:在欄位設定動態初值,透過 REST Services 回傳單筆資料,並以回傳欄位(例如 title)作為欄位初值。

選取欄位並準備設定動態初值
  1. 在設計器中選取要設定初值的欄位,於右側屬性面板找到初值相關設定,並選擇以 Action Flow 設計動態初值。

  2. 進入動態初值的流程編輯器後,依序加入 REST ServicesAssign Variables。 Assign Variables 為預設的的節點標題命名為「傳回運算值」,方便辨識。

  3. 點選流程中的 REST Services 開啟設定視窗,於傳回型別選擇 單筆,並在 Request URL 輸入要呼叫的 API(示範:https://jsonplaceholder.typicode.com/posts/1)。

  4. 點選測試檢視回應內容,確認回傳資料正確後關閉視窗,並按確定完成 REST Services 設定。

  5. 接著點選流程中的 Assign Variables(傳回運算值),將目的設定為 Output.value,並在欄位選取 REST Services 回傳的欄位(示範使用 title(Column))。完成後按確定

  6. 確認流程順序為:開始 → REST Services → 傳回運算值(Assign Variables)→ 結束,按右下角確定儲存流程。

  7. 回到設計器後請先存檔,再按預覽進行測試。

  8. 在執行/預覽畫面進入新增或編輯狀態時,欄位會自動帶入 REST Services 回傳的值(示範:title 文字)。

範例2:回傳多筆,作為動態清單

此範例示範:欄位使用動態清單時,透過 REST Services 回傳多筆資料,並以回傳的 Table 作為清單來源,讓使用者在下拉選單中選取。

選取欄位並準備設定動態清單
  1. 在設計器中選取要設定清單的欄位(示範:Rest(動態清單)),於右側屬性面板的清單設定,選擇以 Action Flow 設計動態清單。

  2. 進入動態清單流程編輯器後,依序加入 REST ServicesAssign Variables。 Assign Variables 為預設的節點標題命名為「傳回動態清單」。

  3. 點選流程中的 REST Services 開啟設定視窗,於傳回型別選擇 多筆,並在 Request URL 輸入要呼叫的 API(示範:https://jsonplaceholder.typicode.com/posts)。

  4. 可點選測試檢視回應內容是否為多筆資料;確認無誤後按確定完成 REST Services 設定。

  5. 接著點選流程中的 Assign Variables(傳回動態清單),將目的設定為 Output.value,並在欄位選取 REST Services 回傳的 Table(Table)。完成後按確定

  6. 完成流程設定後回到設計器,請先存檔並按預覽測試。

  7. 在執行/預覽畫面開啟欄位的下拉選單,即可看到由 REST Services 回傳的清單資料(示範:列表選項)。

關於我們 網站導覽 隱私權保護及著作權聲明 服務專線:(02)2726-0885