想要連線至 Workiva 預先建立的 Premium 連接器以外的第三方應用程式?您可以利用HTTP Request Connector Commands 來與 REST API 互動。
在本連線學習流程中,我們將建立一個 Chains(自動化工作流程),與第三方 API 進行驗證,以獲得一個不記名令牌。 雖然我們會使用 Workiva API 來進行示範,但其原理和流程也可套用於連接/串連其他各種 API。
| 主要業務使用個案 | 連接/串連第三方系統 |
| 主要學習目標 | 學習 Chains(自動化工作流程)的基本概念,並利用 Workiva 的 HTTP Request Connector Commands 連接/串連第三方 REST API 並進行認證。 |
| 次要學習目標 | 建立工作區變數 |
| 必要條件 | 配置 Workiva API 授與 配置 HTTP 請求連接器 |
| 支援範本 | CLP | 生成存取/使用權限 |
步驟 1:建立工作區變數
為了在多個鏈結和命令中使用 Workiva API 詳細資訊,我們將建立 Workspace 變數來儲存該資訊。我們將為下列資料建立三個工作區變數:API 授權用戶端 ID 與用戶端機密,以及 IAM(身分與存取管理)基本 URL。
- 從鏈結建立器 ,巡覽工作區設定 。
- 在工作區變數 中,點選三次加號 (+) 以建立三個工作區變數,並將其組態設定如下:
- 變數 1:
- 名稱: wsv-Workiva API Client ID
- 值: 輸入您 API 授與的客戶 ID 。
要尋找客戶 ID,請在 Workiva 平台內巡覽您的個人資料,並在安全標籤下找到 API 授與。
如需 API 授與的更多協助,請遵循以下說明 。
- 變數 2:
- 名稱:wsv-Workiva API 客戶機密
- 值: 輸入您 API 授與的客戶 ID 。
要尋找客戶機密,請在 Workiva 平台內巡覽您的個人資料,並在安全標籤下找到 API 授與。
按照以下指示尋找您的客戶機密 -
按一下鎖定按鈕,以加密您的客戶機密。
保持客戶機密安全非常重要;請將客戶機密儲存到安全位置,以防您需要再次存取/使用。
-
變數 3:
- 名稱: wsv-BaseURL-IAM
- 值: 根據您的區域輸入以下值。您可以透過檢查 URL 來驗證地區。如果 URL 包含
EU或APAC,請使用相應的 URL。
附註: 美國地區僅包含「app」。
欄位 美國值 IAM 基本 URL https://api.app.wdesk.com 欄位 歐盟值 IAM 基本 URL https://api.eu.wdesk.com 欄位 APAC 值 IAM 基本 URL https://api.apac.wdesk.com - 另存新檔工作區設定。
- 變數 1:
步驟 2:建立連鎖
建立新的Chains(自動化工作流程),我們將使用POST 命令建立新的Chains(自動化工作流程) ;這將提供我們所需的承載令牌。
- 巡覽 Chain Builder 中的Chains Tab 。
- 建立新的 Chains(自動化工作流程),並命名該 Chains:CLP | Generate Access Token 。
- 包括描述:此 Chains(自動化工作流程)會產生一個新的 Workiva API Access Token。 您必須在下面的變數值中提供上一步/上一個有效的 Client ID & Client Secret(來自先前產生的 API 授權)。
- 保存 鏈條。
步驟 3:擷取權標
此 Chains(自動化工作流程)使用 HTTP Request Connector 的POST命令來擷取我們的 Bearer Token。承載者令牌是存取 API 所需的重要驗證憑證。一旦在 Chains(自動化工作流程)中取得,標記就可在後續命令中使用,以提供與 API 互動的授權。
- 從HTTP Request 連接器新增PostCommand 至 Start 區域。
- 雙擊該命令進行組態。
- 重新命名命令:POST - 擷取一個令牌 。
- 勾選顯示回應 。
- 在URL 欄位中填入您需要點擊的端點的 URL。要擷取 Workiva API 的令牌,請使用工作區變數填入 IAM Base URL,並將 URL 填入以下內容。
- 點選URL ,然後在「選取變數」面板中點選工作區 ,並選擇您在步驟 1 中建立的變數 (wsv-BaseURL-IAM)。
- 在變數後新增置/oauth2/token 。
- 在Content Type 欄位中輸入:application/x-www-form-urlencoded 。
- 使用Plus 符號,新增Header欄位。
- 資料鍵/金鑰接受者
- 值: application/json
- 使用 加號 即可新增另一個 標頭 欄位。
- 索引鍵: X 版本
- 值:2026-01-01
我們將告訴端點如何使用張貼表格 中的參數執行。點選表格區段 (UI)/章節旁的綠色加號按鈕 4 次,然後在每個欄位填入下列值,特別注意字母大小寫。
- 欄位 1:
- 名稱: client_id
- 值: <wsv-Workiva>
在Select a Variable 面板中,點擊向下箭頭展開Workspace ,並選擇wsv-Workiva API Client ID 。
- 欄位 2:
- 名稱: client_secret
- 值: <wsv-Workiva>
在Select a Variable 面板中,點擊向下箭頭展開Workspace ,並選擇wsv-Workiva API Client Secret 。
- 欄位 3:
- 名稱: grant_type
- 值: client_credentials
- 欄位 4:
- 名稱: 範圍
- 值: 選項可在此新增一個值,指定此記憶體應該存取/使用哪些範圍。
-
使用下面的樣本有效載荷填入回報 ,這樣做,我們就為命令輸出提供了格式設定,使返回的每個變數更容易使用。
{ "access_token":"string", "expires_in":「整數」, 「範圍」:"string", "token_type":"string" }
- (選項) 輸入說明 :"此 HTTP 命令執行 POST 呼叫,以產生在使用 Workiva IAM API 的後續 HTTP 命令中進行驗證所需的存取令牌。此命令利用工作區變數儲存 Workiva IAM API 的基本 URL 以及 API 授權用戶端 ID 與用戶端機密。可以在此處找到更多資訊:https://developers.workiva.com/2026-01-01/tokenrequest.html。
- 儲存 指令。
提示要確定如何填充表單和回應欄位,請查看您所連線的 API 端點的開發人員文件。對於 Workiva API,您可以尋找 Bearer Token 說明文件 。
第 4 級距:測試步驟
現在 Chain 已經完成,請測試結果。
- 發表鏈結。
- 按一下Execute ,然後按Run Chain 。
-
一旦 Chains(自動化工作流程)執行完畢,您應該可以在Post 命令的Outputs tab - Response Body 中看到存取令牌已經產生。
查看 HTTP Request 連線學習路徑中的下一步/下一個練習,學習如何在隨後的命令清單試算表中使用承載令牌 。