影片資源
觀看此短影片，瞭解如何設定和使用工作流程 API。建立工作流程 API
透過以下步驟建立工作流程 API：-
在工作流程畫布上，右鍵單擊端口並選擇 建立 API 設定。
工作流程 API 目前不支援某些端口。如果端口不受支援，當你嘗試將該端口新增到工作流程 API 時， 會顯示一條錯誤訊息。有關不能在工作流程 API 中使用的端口清單，請參閱不支援的端口。 -
建立 API 設定 頁面會開啟。在 方法 欄位中，選擇你希望工作流程 API 接受請求的 HTTP 方法。選項包括 GET、POST、PUT、PATCH 和 DELETE。建立工作流程 API 後，可以根據需要更改此設定。
-
在 路徑 欄位中，輸入工作流程 API 的名稱。發出 API 查詢時會使用此名稱。
只有當 API 名稱執行不同功能時，才可以重複使用。例如，可以有一個名為 API_X12、執行 POST 功能的工作流程 API，也可以有一個名為 API_X12、執行 PATCH 功能的工作流程 API，但不能有兩個都名為 API_x12 且都執行 POST 功能的工作流程 API。
-
單擊 建立 API。系統會在設定索引標籤中開啟工作流程 API 設定，工作流程 API 也會顯示在工作區中。
- 將其他端口拖到工作流程 API 框中，並將它們連線在一起。也可以向工作流程 API 框新增註解。
工作流程 API 中的第一個端口從發出查詢的實體接收輸入資料，最後一個端口將輸出資料傳送回發出查詢的實體。
不支援的端口
工作流程 API 中的端口必須以一種方式連線，從而為每個輸入訊息產生一個輸出訊息。不支援基於計劃或外部處理程序處理檔案的端口。因此，工作流程 API 中不允許使用以下端口：工作流程 API 範例
以下範例顯示了一個配置為 POST 的工作流程 API 的真實用例：
- 資料在開始節點以加密的 X12 檔案形式接收。
- OpenPGP_Decrypt 端口解密 X12 檔案，並將其傳遞給 X12 端口。
- X12 端口將 X12 檔案轉換為 XML，並將轉換後的 XML 檔案傳遞給 JSON 端口。
- JSON 端口將 XML 檔案轉換為 JSON 格式，並將轉換後的檔案傳遞給 OpenPGP_Encrypt 端口，後者對 JSON 檔案進行加密。
- 加密的 JSON 檔案透過結束節點傳回。
配置和測試工作流程 API
建立工作流程 API 後，可以配置其設定並執行範例請求來測試配置。配置設定
單擊工作流程 API 標題中的齒輪狀設定圖示，以開啟 設定 面板。
請求
在 路徑 欄位中，選擇工作流程 API 的請求型別。如果更改請求型別，請確保端口的結構和配置對於新的請求型別是正確的。 使用 說明 欄位輸入工作流程 API 的可選描述。當你有多個工作流程 API 並希望跟蹤每個工作流程 API 的用途時，這會很有用。中繼資料頭
請求中包含的所有頭資訊都會隨訊息在工作流程中傳遞時保留下來。這些頭以API-Header- 為字首，因此名為 MyHeader 的頭將顯示為 API-Header-MyHeader。在日誌頁面中展開訊息或交易時，或檢視訊息詳情時，可以看到這些頭。也可以在端口的 交易記錄 索引標籤上展開交易時檢視頭資訊。
查詢參數
此部分使你能夠為工作流程指定查詢字串參數。如果在此處新增參數，當訊息沿工作流程向下傳遞時，它們將作為中繼資料頭保留下來。這些頭以API-QueryParameter- 為字首，因此 test 的查詢字串將使用 API-QueryParameter-test。這些頭與中繼資料頭顯示在相同的位置。
如果你希望將某些資訊作為請求的一部分傳遞，但該資訊不是請求體的一部分，那麼此功能會很有用。例如，如果想要查詢資料庫中特定公司的最近銷售訂單 ID，可以將 CompanyName 查詢參數新增到 API 中，並在工作流程中使用 API-QueryParameter-CompanyName 頭引用它。
主體和回應
在 主體 部分中，選擇與查詢用戶端和工作流程 API 通訊方式相對應的 型別：- None—請求中不預期包含主體
- Raw—任意格式的自由格式資料
- Form data—名稱-值對
- x-www-form-urlencoded
處理二進位檔案
工作流程 API 支援將二進位檔案（PDF、JPEG 或其他二進位檔案型別）作為請求體或回應體進行上傳和下載。開啟測試面板（參見測試工作流程 API）時，工作流程 API 包含：-
當請求體內容類型為二進位檔案時，提供檔案上傳按鈕，如下圖所示
- 當回應內容類型為二進位檔案時，提供檔案下載按鈕
如果需要 API 傳回 Base64 編碼的文字而不是二進位檔案，需要使用 Script 端口將輸出編碼為 Base64，並將回應內容類型設定為類似
text/plain 的型別。呼叫存取使用者
要檢視能夠呼叫工作流程 API 的使用者，請開啟設定面板並點選呼叫存取使用者。此索引標籤根據分配給使用者的策略，列出能夠呼叫該 API 的所有標準使用者和服務使用者。點選新增使用者可授予其他使用者呼叫權限。
測試工作流程 API
要開啟工作流程 API 的測試面板，請單擊工作流程 API 標題中的三角形圖示。
將工作流程 API 與外部應用程式一起使用
以下步驟說明如何從外部用戶端呼叫工作流程 API。此範例展示瞭如何從 Postman 執行工作流程 API，但也可以使用任何能夠傳送 REST 請求的用戶端。- 使用工作流程設計器右下角的 選擇多個端口 選項，選擇要公開為 API 的工作流程。然後單擊 建立 API 設定。此操作會開啟 建立 API 設定 對話方塊。
-
選擇一個方法（例如 POST），如下所示，併為 API 指定一個有意義的名稱。
- 單擊 建立 API 建立工作流程 API。
- 在 設定 面板中，配置工作流程 API，以在 主體 部分定義預期的 Content-Type 值，並在 回應 部分定義所需回應的 Content-Type 值。也可以選擇為請求和回應提供範例資料。
- 複製請求面板中顯示的路徑。
-
開啟 Postman 應用程式。確保 Content-Type 下拉式清單中顯示相同的內容類型（在本例中為 POST）。然後，將在 中複製的路徑（第 5 步）貼上到請求 URL 欄位中。將請求正文指定為應啟動工作流程的內容。
-
對工作流程 API 進行身分驗證。工作流程 API 使用與 Admin API 相同的身分驗證規則。此範例使用身分驗證權杖頭（x-cdata-authtoken）作為身分驗證方法。
要使用該方法：
- 單擊導覽列上的 設定 齒輪圖示。然後，單擊 新增 以開啟 新增使用者 對話方塊，或編輯現有使用者。
- 在出現的對話方塊中，選中 API Access 核取方塊以顯示身分驗證權杖。（請將此權杖複製到安全位置，因為該對話方塊不會再次顯示。如果丟失或刪除身分驗證權杖，則必須建立新權杖。）然後單擊 儲存更改。
-
傳回 Postman 應用程式並按如下方式新增工作流程 API 的身分驗證憑據：
- 單擊 Headers 索引標籤。
- 將 x-cdata-authtoken 貼上到 Key 欄位中。
- 將在 中複製的身分驗證權杖貼上到 Value 欄位中。
-
請求準備就緒後，單擊 Send 按鈕。應該會看到對所傳送請求的回應，如下例所示：
