想要在 Workiva 預建的 Premium 連接器之外連接第三方應用程式?您可以利用 HTTP Request 連接器命令來與 REST API 互動,以達到此目的。在此連線學習流程中,我們將更新鏈結,在使用 list Spreadsheets 端點的命令中使用 Bearer Token,以提供工作區中的試算表清單。
附註: 雖然此標籤為 HTTP Request,但支援 HTTPS (Secure HTTP)(並建議使用)。
| 主要業務使用個案 | 連接/串連第三方系統 |
| 主要學習目標 | 使用 HTTP Request 連接器學習 Chains(自動化工作流程)的基本概念 |
| 必要條件 | 配置 Workiva API 授權與 配置 HTTP 請求連接器 CLP - HTTP 請求產生一個令牌 |
| 支援範本 | CLP - HTTP 要求者清單試算表 |
步驟 1:建立工作區變數
為了在多個鏈結和命令中使用 Workiva API 詳情,我們將建立 Workspace 變數以儲存該資訊。我們將為 Platform API URL 建立新的工作區變數。
- 從鏈結建立器 ,巡覽工作區設定 。
- 在工作區變數 下,按一下加號以建立新的工作區變數。
-
使用下列資訊組態變數:
- 名稱: wsv-BaseURL-Platform
- 值: 根據您的區域,使用適當的值。您可以透過檢查 URL 來驗證地區;如果 URL 包含
EU或APAC,請使用相應的 URL。否則使用 US 值。
附註: 美國地區僅包含 "app"。
欄位 美國值 IAM 基本 URL https://api.app.wdesk.com/platform/v1 欄位 歐盟值 IAM 基本 URL https://api.eu.wdesk.com/platform/v1 欄位 APAC 值 IAM 基本 URL https://api.apac.wdesk.com/platform/v1 - 儲存工作區設定.
附註: 您應該可以在工作區設定中看到這四個變數。 如果沒有,請重新瀏覽上文附 註 的 先 決 條 件 。
第 2 級距:複製並修改 Chains(自動化工作流程)。
- 巡覽到 Chain Builder 並找到名為CLP | Generate a Token 的鏈結。
- 點選右邊的垂直橢圓,選取複製 。
- 建立鏈複製後,點擊鉛筆圖示編輯鏈結。
- 按一下右上方的Chains Settings 。
- 重新命名 Chains(自動化工作流程):CLP | HTTP 要求者清單試算表.
- (選項) 輸入一個描述 :"此 Chains(自動化工作流程)會產生一個新的 Workiva API Access Token。您必須在下面的變數值中提供上一步/上一個 API 授權中的有效客戶 ID 和客戶機密。然後,它會擷取工作區內所有試算表的清單。您的工作區必須至少有一個或多個試算表"。
- 保存 鏈條。
第 3 級距:試算表列表
若要擷取試算表清單,此 Chains(自動化 HTTP 請求連接器)會使用GET 命令 。
- 從HTTP Request 連接器新增Get命令至 Chains(自動化工作流程)。
- 連接貼文 - 擷取令牌 命令至Get 命令。
- 雙擊該命令進行組態設定。
- 重新命名命令:取得試算表清單
- 按一下命令,然後按一下相關的鉛筆圖示,以編輯命令。
- 勾選顯示回應 核取方塊。
- 點選URL ,然後在「選取變數」面板中點選工作區 ,選取您在步驟 1 中建立的變數 (wsv-BaseURL-Platform)。
- 在變數後新增置/spreadsheet 。
下一步/下一個,我們將透過在Get 表單中指定Headers來告訴端點如何執行。
這些頁首/標頭會傳送 Bearer Token 到 API,以顯示我們有存取/使用試算表清單的權限。 - 按兩下頁首/標頭區段旁的灰色加號 (+) 按鈕,然後按以下值填入每個欄位,特別注意字母大小寫和「Bearer」後的間距。
- 頁首/標頭欄位 1:
- 資料鍵/金鑰 接受者
- 值: application/json
- 頁首字段 2 :
- 資料鍵/金鑰 作者
-
值: Bearer<Post>
用 POST - Retrieve a Token Command 的輸出取代 <Post> 。- 在Select a Variable 面板中,點選Runtime 向下箭頭,展開POST - Retrieve a Token。
- 按一下Response 旁邊的向下箭頭,以展開變數選項。
- 選取Access_token 。
- 頁首/標頭欄位 1:
-
以下列內容填入內容類型 :application/json.
-
使用下面的樣本有效載荷填入回應。我們這樣做是為 Command 的輸出提供格式設定,讓每個回傳的變數更容易使用。
{ 「資料」:[ { 「建立」:{ "dateTime":"2018-10-21T15:03:27Z" }, "name":「年終審閱者」,"ID":"124efa2a142f472ba1ceab34ed18915f", "modified":{ "dateTime":"2018-10-21T15:03:27Z" }, 「範本」: false }, { "created":{ "dateTime":"2020-02-20T15:03:27Z" }, "name":「Q1 審閱者」, "ID":"164cfb2b132c4623a2cfaa31ef13925a", "modified":{ "dateTime":"2020-03-29T13:15:27Z" }, 「範本」: false }], "@nextLink":"<opaque_url>"} -
(選項) 輸入一個描述 :"This command returns one page of a list of Spreadsheet.此命令返回試算表清單的其中一頁。如需詳細資訊,請參閱 https://developers.workiva.com/platform-v1/platform-getspreadsheets/ " 的開發人員說明文件。
提示若要確定如何填入頁首和回應欄位,請查看您所連線的 API 結點的開發人員文件,在本例中,我們使用 "Get Spreadsheets" 結點。
- 儲存指令。
第 4 級距:測試步驟
現在 Chain 已經完成,請測試結果。
- 發表鏈結。
- 按一下Execute ,然後按Run Chain 。
- 一旦 Chains(自動化工作流程)執行完畢,您應該可以在 Get Command 的Outputs tab - Response Body 中看到試算表清單。
若要繼續挑戰自己並進一步了解如何使用 HTTP Request Connector 連接第三方 API,請查看下一步/下一個練習:CLP - HTTP Request Get a Single Spreadsheet 。