想要在 Workiva 預建的 Premium 連接器之外連接第三方應用程式?您可以利用 HTTP Request 連接器命令來與 REST API 互動,以達到此目的。在此連線學習流程中,我們將更新鏈結,在使用 list Spreadsheets 端點的命令中使用 Bearer Token,以提供工作區中的試算表清單。
注意: 雖然這標記為 HTTP 要求,但它支援(且建議使用)HTTPS(安全 HTTP)。
| 主要業務使用個案 | 連接/串連第三方系統 |
| 主要學習目標 | 使用 HTTP Request 連接器學習 Chains(自動化工作流程)的基本概念 |
| 必要條件 | 設定 Workiva API 授與設定 HTTP 要求連接器 CLP - HTTP 要求產生權杖 |
| 支援範本 | CLP - HTTP 要求者清單試算表 |
步驟 1:建立工作區變數
為了在多個鏈結和命令中使用 Workiva API 詳情,我們將建立 Workspace 變數以儲存該資訊。我們將為 Platform API URL 建立新的工作區變數。
- 從 Chain Builder導覽至 Workspace Settings。
- 在 「工作區變數」下,按一下加號以建立新的「工作區變數」。
-
使用下列資訊組態變數:
- 名稱: wsv-BaseURL-Platform
- 值: 根據您所在的區域,使用適當的值。您可以檢查 URL 來驗證區域;如果 URL 包含
EU或APAC,請使用對應的 URL。否則使用 US 值。
注意: 美國地區僅包含「app」。
欄位 美國值 IAM 基本 URL https://api.app.wdesk.com 欄位 歐盟值 IAM 基本 URL https://api.eu.wdesk.com 欄位 APAC 值 IAM 基本 URL https://api.apac.wdesk.com 欄位 CA 值 IAM 基本 URL https://api.ca.wdesk.com - 儲存 工作區設定。
注意: 您應該會在「工作區設定」中看到所有這些變數。如果不是,請重新查看上述 先決條件
第 2 級距:複製並修改 Chains(自動化工作流程)。
- 巡覽至鏈結產生器並找到名為 CLP | 的鏈結。產生 Token 。
- 按一下右側的垂直橢圓形,然後選取 「複製」。
- 建立鏈複製後,點擊鉛筆圖示編輯鏈結。
- 按一下右上角的 Chain Settings 。
- 重新命名鏈結: CLP | HTTP 要求清單試算表。
- (可選)輸入 說明:「此鏈結會產生新的 Workiva API 存取權杖。您必須在下面的變數值中提供上一步/上一個 API 授權中的有效客戶 ID 和客戶機密。然後,它會擷取工作區內所有試算表的清單。您的工作區必須至少有一個或多個試算表"。
- 保存 鏈條。
第 3 級距:試算表列表
若要擷取我們的試算表清單,此鏈結使用 GET 命令 從 HTTP 要求連接器。
- 新增來自 HTTP要求 連接器的「 取得 命令」至「鏈結」畫布。
- Connect the Post - Retrieve a Token Command 至 Get命令。
- 雙擊該命令進行組態設定。
- 重新命名命令: 取得 - 試算表清單
- 按一下命令,然後按一下相關的鉛筆圖示,以編輯命令。
- 勾選 Show Response 核取方塊。
- 在 URL 中按一下,然後在「選取變數」(Select a variable) 面板中按一下「 工作區」(Workspace) ,並選取您在第 1 步中建立的變數 (wsv-BaseURL-Platform)。
- 在變數後新增 /spreadsheets 。接下
來,我們將透過在 「取得」 表單中指定 標題 來告訴端點如何執行。 - 按一下兩次 「頁首」(Header) 區段旁的灰色加號 (+) 按鈕,並使用以下值填入各欄位,並特別注意字母大小寫和「不記名」(Bearer) 後的空格。
- 頁首/標頭欄位 1:
- 使用 加 號新增 頁首 欄位。
- 金鑰: 接受
- 值: 應用程式/json
- 頁首欄位 2:
- 使用 加 號新增另一個 頁首 欄位。
- 金鑰: X 版本
- 值:2026-01-01
-
我們會使用填入 Post Form 的參數來告訴端點如何執行。點選表格區段 (UI)/章節旁的綠色加號按鈕 4 次,然後在每個欄位填入下列值,特別注意字母大小寫。
-
- 欄位 1:
- 名稱: client_id
- 值: <wsv-Workiva API Client ID>
在 「選取變數」面板按一下向下箭頭以展開 「工作區」 並選取 「wsv-Workiva API Client ID」。
- 欄位 2:
- 名稱: client_secret
- 值: <wsv-Workiva API Client Secret>
在 「選取變數」面板中,按一下向下箭頭以展開 「工作區」 並選取 「wsv-Workiva API Client Secret」。
- 欄位 3:
- 名稱: Grant_type
- 值: client_credentials
- 欄位 4:
- 名稱: 範圍
- 值: 選擇性地在此處新增一個值,以指定此權杖應具有存取權的範圍。
- 欄位 1:
- 使用下面的樣本有效載荷填入回應。我們這樣做是為 Command 的輸出提供格式設定,讓每個回傳的變數更容易使用。
{ "access_token":"string", "expires_in":「整數」, 「範圍」:"string", "token_type":"string" }-
(可選)輸入 說明:「此命令會傳回試算表清單中的一頁。有關詳細資訊,請參閱開發人員說明文件,網址為 https://developers.workiva.com/2026-01-01/getspreadsheets.html
提示若要確定如何填入「標頭」和「回應」欄位,請查看您要連結的 API 端點的開發人員文件,在本例中,我們使用「取得試算表」端點。
- 儲存指令。
第 4 級距:測試步驟
現在 Chain 已經完成,請測試結果。
- 發布 鏈結。
- 按一下 Execute ,然後按一下 Run Chain。
- 鏈結完成執行後,您應該在 「輸出」(Outputs) 索引標籤 - 取得命令的「回應」(Response Body) 中看到試算表清單。
若要繼續挑戰自我並進一步了解使用 HTTP 要求連接器連結第三方 API,請查看下一個練習: CLP - HTTP 要求取得單一試算表。