跳到主要內容
:::

教育百科logo

:::

一、API 介紹

資源檢索應用程式介面:教育百科提供以下兩種不同資料格式內容,方便使用者依照需求引用「教育百科」資源,包含詞條檢索結果、詞條內容顯示。

二、會員註冊取得API Key

  1. 本平臺提供透過 API 取用資料,惟因本平臺採用會員服務機制,需帶入會員之 API 金鑰,方可取得各式開放資料。
  2. 於會員註冊 (https://pedia.cloud.edu.tw/SsoLogin/Home) 後,平臺將寄出會員註冊信件。
  3. 登入會員後,至「進入會員頁面」,取得會員之 API Key 金鑰

三、以「資料擷取API線上說明文件」存取資料,供應用程式介接

(1) 取得 API URL

  • 步驟一:進入教育百科資料擷取API線上說明文件: https://pedia.cloud.edu.tw/apiui.html
  • 步驟二:點擊欲取得資料的資料集,再點擊「Try it out」
  • 步驟三:每個資料集 API 各有其可運用的參數,以「樂不思蜀」詞條檢索為例,可使用以下圖之三項參數。填入參數後,點擊「Execute」。
  • 步驟四:以「樂不思蜀」詞條檢索為例,可取得 API URL:
    https://pedia.cloud.edu.tw/api/v2/List?keyword=%E6%A8%82%E4%B8%8D%E6%80%9D%E8%9C%80&page=1&api_key=your-api-key

(2) API 參數說明

詞條檢索結果 API URL 格式:
https://pedia.cloud.edu.tw/api/v2/List?keyword={keyword}&page={page}&api_key={api-key}
詞條內容顯示 API URL 格式:
https://pedia.cloud.edu.tw/api/v2/Detail?term={term}&api_key={api-key}
  • {keyword}
    需要檢索的關鍵字
  • {page}
    取第 n 頁檢索結果
  • {api-key}
    資料下載會員 API 金鑰,「會員註冊」後可取得。
  • {term}
    需要搜尋的詞條名稱