API取數使用說明

FDL 提供兩個功能進行API取數，差別如下：

本文介紹這兩個功能在實際場景中如何使用。

注：若 API 取數時用到了參數，需注意：「參數指派」節點、「參數匯出」算子中，設定參數時若開啟了「閉包符」，則參數值預設加上單引號， API 取數時引用參數若再加上單引號或雙引號，可能會導致取數失敗；所以，是否開啟「閉包符」請根據實際情況衡量。

2.1 API取數後儲存到XX

2.1.1 場景說明

API取數後經過簡單解析就得到想要的資料。

2.1.2 使用方法

使用方式一：

使用 資料同步-API ，得到想要資料

如下圖所示：

使用方式二：

使用 API輸入 算子讀取API資料，再使用 JSON解析  OR XML解析 算子進行解析，可繼續使用其他資料處理算子對資料進行處理，最後將資料匯出。

2.1.3 範例參考

資料同步-API

XML解析

僅在工作日執行定時任務

呼叫定時任務相關API說明

2.2 API取數後匯出為參數

2.2.1 應用場景

呼叫API A 匯出參數，供後續節點/算子使用。

2.2.2 使用說明

參數指派 節點、參數匯出 算子、全局參數-指派參數 都支援將 API 資料匯出為參數，支援獲取API回應的回應頭header、回應體body、狀態碼。

詳細說明請參見：與參數功能配合使用說明

2.2.3 範例說明

希望呼叫 獲取部門列表 API，獲取所有部門 id。但 獲取部門列表 API呼叫時需要使用 access_token 參數，access_token 參數需要呼叫 獲取access_token API獲得。

所以，需要先呼叫 獲取access_token API，獲取 access_token 並匯出為參數供 獲取部門列表 API使用。

完整範例：API取數-獲取企業微信人員資訊 文檔的第一章到 2.2 節內容。

3.1 場景說明

API API中，包含分頁相關參數（資料頁數、每一頁資料條數、分頁參數等）、限制一次只能取 XX 資料，可嘗試使用分頁取數方案。如下圖所示：

3.2 使用說明

注：分頁取數時，若某頁沒有資料，取出資料為空可能會任務報錯。

方式一：

FDL 提供分頁取數功能，詳情請參見：API輸入-分頁取數

方式二：

需要與「循環容器」節點配合使用，建議使用者先了解「循環容器」節點的使用，再參考分頁取數範例學習。

3.3 範例

詳情請參見：API取數概述

嵌套循環取數可參見：嵌套循環取數

4.1 應用場景

使用者需要從 API API取數， 但 API API中參數每次只能讀取一個參數值。所以需要將待呼叫API用到的參數值取出並作為參數匯出，使用「循環容器」節點，遍歷所有參數從 API API取數。

注：使用者根據實際場景，設定循環方式為「遍歷循環」 OR 「條件循環」，詳情請參見 循環容器邏輯說明

4.2 使用說明

參數功能+APIAPI取數功能+循環容器配合使用。

範例如下：

需要呼叫 獲取部門成員 API獲取 userid 資料，而呼叫該API需要用到參數 access_token 和 department_id，獲取部門成員 API每次只能讀取一個參數：

1）呼叫 獲取 access_token API獲取 access_token 並作為參數匯出（參數值為動態）

2）呼叫 獲取部門列表 API，獲取所有的 department_id 並將 department_id 作為參數匯出（多個參數）

3）使用「循環容器」節點，access_token 參數、department_id 參數傳遞給「循環容器」節點，「循環容器」節點內遍歷所有參數進行API取數

範例詳情請參見：API取數-獲取企業微信人員資訊 文檔的第一章到 2.3 節內容

4.3 更多範例參考

使用高德API獲取城市天氣資料

將經緯度資料轉換為中文地址

按日期分表，每天儲存當天資料

5.1 應用場景

一些API呼叫時參數需要加密，例如：獲取工單欄表 API呼叫時需要攜帶簽章參數 sign，只有當 sign 值合法時請求才會被接受。

5.2 使用方法

在「Spark SQL」算子中，使用 加密函式 對參數進行加密。

5.3 範例

參數使用MD5加密後從API取數

使用FDLAPI形式實現阿里雲伺服器資料監聽

API取數-SHA2加密身分驗證&按頁數取數