API 連接器
info
- API Connector 功能僅支援連結 RESTful API,且 API 的 Response 型態需為 JSON 格式(如 JSON object 或 JSON array)。
- API Connector 功能適合用於低資料量的 RESTful API,建議單一 JSON 檔案不超過 10MB。
Step 1: 建立資料來源
您可以透過以下兩種操作來建立資料來源,第一種為點擊側欄 Data Source 的 “+” 按鈕,或是點擊 Overview 頁面中的 Create a Data Source 按鈕來建立。
Step 2: 設定連線資訊
在彈出的視窗表單中,填入及設定連線資訊,並點擊 Submit 送出,相關連線欄位設定細節如下方說明。
相關連線欄位設定細節如下方說明。
Basic
- Name:資料來源於 Canner Enterprise 之顯示名稱,後續可作修改。
- Data Source Type : 資料庫類型,請選擇
API
。
Data Source Properties
- Base URL:請填入您要連結的 API 路徑,範例格式:
https://a.b.c/path/
。 - Headers : 請填入 API 的請求標頭 (Request Headers)。
info
Headers 最高上限可填入 10 組。
- Ignore Invalid SSL certificate (預設關閉):若您希望連結時忽略或不驗證 SSL 的有效性,請開啟此選項。
- Explore Timeout:系統連結並解析資料來源的逾時限制,若系統執行連結超過此時間,會自動終止並顯示連線錯誤。系統預設逾時限制為
5000 毫秒
,若您要連結的資料庫中資料表(Table) 數量較多,建議可調高此逾時限制。 - Request Timeout:系統等待您連結的 API 回應時間之逾時限制,若系統連結時等待 API 回應超過此時間,會自動終止並顯示連線錯誤。系統預設逾時限制為
30000 毫秒
,若您要連結的 API 回應時間較長,建議可調高此逾時限制。
API Endpoints
可在相同 Base URL 下,填入多組 API Endpoints ,每一組 API Endpoint 連結後會建立一張資料表(Table) 在Data Source 頁面的Tables 頁籤中。
info
API Endpoints 最高上限可填入 10 組。
- URL Path:請填入您要連結的 API Endpoint 路徑
GET / POST
: 請選擇 API 請求方法,支援GET
或POST
。
danger
URL Path 內容須為合法 Http Protocol 字元,若有不合法字元,須自行escape。
- Table Name : 此資料表於 Canner Enterprise 之顯示名稱,後續可作修改。
- Column Schema:請定義此 API Endpoint 取得資料之欄位結構。
Column Name
: 請填入欄位名稱。Type
:請填入欄位對應的資料型別,支援double
,varchar
,boolean
,bigint
。
Step 3: 完成建立
Submit 送出後,稍後片刻會跳回列表頁面,並可看到您剛設定的 API 會出現在資料來源列表中。