1. 概述
本文介紹如何將 FineDataLink 資料服務 發佈API 中請求方式為 POST（application/json）類型的API資料取出。
注：若使用者需要使用自己系統中的 API 進行取數，可參見：API採集資料專題
2. API文檔
已經發布的 API API說明如下：
請求說明：
| 請求域名 | 發布 API 中使用的 FineDataLink 伺服器地址 例如：http://192.168.5.175:8068/webroot 若需要自訂Web容器存取路徑，可聯系技術支援獲取方案，技術支援聯系方式：前往「服務」，選擇「線上支援」、電話「400-811-8890」。 | ||||||
|---|---|---|---|---|---|---|---|
| 請求地址 | 資料服務所發布 API 的地址 例如：http://192.168.5.175:8068/webroot/service/publish/a73a7179-20b8-40db-a4e5-15f10d75ff67/wendang 注：可直接在發布介面複制API請求地址。 API存取路徑「請求域名」+「應用路徑前綴」+「應用ID」+「APIPath」
| ||||||
| 請求方式 | POST | ||||||
| ContentType | application/json |
POST 請求body參數：
| 參數 | 類型 | 參數必填按鈕 | 說明 | 備注 |
|---|---|---|---|---|
| pageNum | 數值 | 預設開啟 | 分頁參數 pageNum 為頁數，數值可自訂 | 若不開啟 分頁查詢 按鈕，Body 中無需填入這些參數 |
| pageSize | 數值 | 預設開啟 | 每頁資料條數，數值可自訂 注：每頁資料條數單次呼叫最大限制為100000 | |
| returnTotalNum | 布爾 | 預設關閉（可開啟） | 是否傳回總的資料條數 | |
| params | 可以為字串、數值、布爾值 | 否 | 自訂參數 如果在發布API時設定了自訂參數，但是請求中未傳此參數，則傳回報錯 | - |
請求範例：
注：此處的 area 為 發佈API 中設定的自訂參數。
回傳值參數：
| 名稱 | 類型 | 描述 | 備注 |
|---|---|---|---|
| output | object | 傳回使用者使用API取出的資料 | - |
| code | int | 錯誤碼；詳情請參見本文第四章內容 | - |
| message | string | success，則傳回成功 失敗時具體原因會在Message中體現；詳情請參見本文第四章內容 | - |
totalNum | int | 傳回取出資料的總資料條數 | 若不開啟 分頁查詢 按鈕，呼叫 API 後傳回資料中沒有這些參數 |
| pageSize | int | 傳回取出資料的每頁資料條數 | |
| pageNum | int | 資料頁數，即從第幾頁開始取 | |
| rowCount | int | 當前頁數包含的資料條數 與 pageNum 頁數有關。比如一共12筆資料，傳入的pageNum是2，pageSize是10。實際會查詢第二頁的資料，實際傳回2 |
回應值範例：
3. 測試API
3.1 獲取API地址
首先在 API 列表介面選擇需要使用的 API，然後在已授權應用處複制路徑，獲取到 API 完整路徑地址，例如：http://localhost:8068/webroot/service/publish/a73a7179-20b8-40db-a4e5-15f10d75ff67/wendang，如下圖所示：
3.2 獲取 API 鑒權
若使用者使用了鑒權，則需要在「應用」中複制 APPCode，如下圖所示：
注：如果開啟了黑白名單，需要保證使用 API 的環境與發布 API 環境之間資訊能互通。
3.3 設定 API 基本資訊
使用任意取數軟體，選擇 POST 請求方式，輸入複制的API連結，選擇「Authorization」，勾選認證類型為「API Key」，輸入Key：Authorization，value ：本文 3.2 節複制的值，選擇 Add to 為 Header，如下圖所示：
注1：複制的連結預設為IP:埠/webroot 路徑，如果使用者的FineDataLink做過Tomcat下透過IP直接存取非容器化工程，則需要給複制的url去掉webroot。
注2：參數值格式為：APPCode+空格+APPCode值，此處的 APPCode 為範例。
然後在Body 中選擇「raw-JSON」，輸入 json 資料，如下圖所示：
範例取出「華北」的資料，因此自訂參數貨主地區的 value 直接寫成華北，將 pageSize 設定為 10，也就是每頁資料限制為 10 條，從第一個開始取數，查看回傳值中，每頁 10 筆資料計算總頁數為多少。
點選 send 後回傳值如下圖所示：
4. API回應碼說明
呼叫回傳值說明詳情參見：資料服務錯誤程式碼表
