跳到主要內容

教育大市集Logo

網站導覽
:::

什麼是『API應用服務』? 運用的場合是?

進入會員中心後,可看到教育大市集提供給會員的各服務項目,就讓我們一起來了解「API 應用服務」吧!
首先請先點選「API 應用服務」功能選項,即可開始應用API服務。

資源設定選擇API 應用服務功能

了解「API 應用服務」及申請API KEY

我們提供API應用服務方式,供您即時查詢及取回教育大市集資源資料。

想了解API應用服務可點擊查看API應用服務,例如:(1)「資源檢索應用程式介面」。

點擊查看API應用服務

(2)資源檢索應用程式介面將進入至「應用程式介接介面」功能。
「應用程式介接介面」提供以關鍵字檢索教育雲、教育大市集之教學資源、開放美工圖庫資源;以教育百科詞條檢索教育雲教學資源、台灣魚類資源、開放美工圖庫資源; 提供取得特定縣市下特定學制中的學校清單、特定縣市的學制清單、縣市清單、大市集系統公告、查詢熱門資源、以學校代碼查詢學校資料、以網址轉換QRCode、以天數查詢新進資源。

提供以關鍵字檢索教育雲之教學資源

您已申請取得API KEY後,可依所需的條件來組合查詢範圍。

以下為關鍵字檢索教育雲、教育大市集之教學資源、以教育百科詞條檢索教育雲教學資源等圖示範例。


「提供以關鍵字檢索教育雲之教學資源」 提供以關鍵字檢索教育雲之教學資源
「提供以關鍵字檢索教育大市集之教學資源」 提供以關鍵字檢索教育大市集之教學資源
「提供以教育百科詞條檢索教育雲教學資源」 提供以教育百科詞條檢索教育雲教學資源

「應用程式介接介面」也提供相關範例,點下「使用範例」連結將進入至「應用程式介面使用範例」功能。
「應用程式介面使用範例」詳述更詳細的介接API網址與應用參數說明,以及預期回應傳回資料形式,提供您應用參考。

點擊查看使用範例
「應用程式介面使用範例」提供詳細的介接API應用說明。 提供應用程式介面使用範例
以「以全文檢索查詢教育大市集之教學資源」範例作為示範。 以全文檢索查詢教育大市集之教學資源的使用範例

或是(1)「精選教學資源應用程式介面」。

點擊查看API應用服務

(2)資源檢索應用程式介面將進入至「精選教學資源應用程式介面」功能。
「精選教學資源應用程式介面」提供以內容分類代碼檢索教育大市集之精選教學資源。
您已申請取得API KEY後,可依所需的條件來組合查詢範圍。 提供以教育百科詞條檢索教育雲教學資源

(1)當您需要如上述的使用API應用服務時,請點擊「申請新的API KEY」。

點擊「申請新的API KEY」鈕

(2)請填入API用途說明,填寫完成按下「送出申請」鈕進行申請。

點擊「送出申請」鈕進行申請API KEY

(3)申請成功,即可看到專屬的API KEY。

申請成功,即可看到專屬的API KEY

查看API KEY用途說明

(1)點擊「查看」用途說明。

點擊「查看」用途說明

(2)可瀏覽及修改API KEY用途說明。

可瀏覽及修改API KEY用途說明

刪除API KEY

當您已不再使用特定一組API KEY時,可選擇並刪除這組API KEY。
(1)點擊「刪除」功能鈕來刪除這組API KEY。

點擊「刪除」功能鈕

(2)出現提示訊息,確認是否刪除這組API KEY,點擊「確定」鈕,即刪除API KEY。

出現提示訊息,確認是否刪除這組API KEY

複製API KEY

為了提升您的使用便利性,我們提供了API KEY複製功能。
(1)點擊API KEY複製功能鈕。

點擊API KEY複製功能鈕

(2)出現提示訊息,告知已將這組API KEY暫存至作業系統的剪貼簿中。

出現提示訊息,告知已將這組API KEY暫存至作業系統的剪貼簿