OpenAPI示範應用

客家委員會OpenAPI平臺(以下稱本平臺)
服務網址為 https://data.hakka.gov.tw/opendata/

平台基本說明

本平臺是將OpenData資料集之內容，以OpenAPI方式提供作為資料的加值應用。
為維護本平臺使用者之權益，本平臺提供之服務，需經由API Key確認用戶端之身份，並記錄每次呼叫本平臺服務之用戶端IP資訊。(不會記錄終端使用者之資訊)
本平臺將不定期查看API Key使用之情況，若判斷相同API Key呼叫服務次數過多或有異常，本會將停用此API Key，並終止使用客委會OpenAPI平台之權利。
也會依情況拒絶該用戶端IP連向客委會相關網站及本平臺之連線。

示範應用與架構建議

本示範應用是以易懂且環境要求較低之方式作說明，以jquery ajax方式呼叫客委會OpenAPI平台提供之最新消息歷史資料之內容。
著重在各項參數傳遞的說明，實際請以系統自動介接(Machine To Machine,M2M)方式規劃及開發。
經由用戶端之伺服器呼叫客委會OpenAPI取回資料後，暫存於用戶端伺服器。再由用戶端伺服器回應給終端使用者。
避免終端使用者使用直接呼叫客委OpenAPI平台，造成大量呼叫本會API服務而被拒絕連線。

示範應用範例程式

在示範應用範例程式中包含了詳細的註解，可參考原始程式中的說明。

示範應用實際使用方式

1. 下載示範應用範例程式

2. 解壓縮後，將看到Sample01.html

3. 以瀏覽器開啟Sample01.html

4. 將申請並審核通過之API Key填入Ｘ-API-KEY欄位。

5. 按下"載入資料"，取得示範應用之資料集內容。

欲取用其它開放資料集之資料，可查看開放資料集。各項參數的詳細呼叫方式，請檢視示範應用範例程式之原始碼。