陸、詮釋資料介接作業

實現跨平臺詮釋資料介接作業，對應所需的應用程式介面（API）、管理功能、交換協定如下說明：

一、詮釋資料交換模式

詮釋資料交換需求包括兩部分：

◼ 詮釋資料集中至「政府資料開放平臺」。

◼ 詮釋資料集中至「政府資料開放平臺」。

(一) 詮釋資料集中至政府資料開放平臺

詮釋資料集中至「政府資料開放平臺」僅接受發布（Publish）交換模式類型。發布（Publish）類型為各資料開放平臺透過「政府資料開放平臺」之資料異動 API，主動將異動（新增、修改、下架）之詮釋資料同步至「政府資料開放平臺」。並且各資料開放平臺可以主動利用 API，從「政府資料開放平臺」查詢與取得詮釋資料。詮釋資料交換模式如下表說明：

表- 2 政府資料開放平臺交換模式
類型	交換模式	作法說明
發布（Publish）	即時發布	各資料開放平臺於詮釋資料異動時，立即呼叫「政府資料開放平臺」之異動資料集詮釋資料 API，進行異動發布。
發布（Publish）	定期發布	各資料開放平臺定期將詮釋資料異動部分，呼叫「政府資料開放平臺」之異動資料集詮釋資料 API，進行異動發布。

以下就各交換模式進行說明，各資料開放平臺可依據實際系統環境需求，選擇 1 種或多種交換模式將詮釋資料集中至「政府資料開放平臺」。

1. 即時發布模式

各資料開放平臺於詮釋資料異動時，立即呼叫「政府資料開放平臺」的資料異動 API，進行異動發布。各資料開放平臺即時發布詮釋資料流程如下圖所示。

圖- 1 各資料開放平臺即時發布詮釋資料流程

各資料開放平臺即時發布詮釋資料流程說明如下：

(1) 各資料開放平臺管理者登入「政府資料開放平臺」系統後端管理介面申請跨平臺介接服務，「政府資料開放平臺」管理者審核通過後，設定其資料發布來源 IP，並提供授權 API KEY。

(2) 各資料開放平臺於詮釋資料異動後，立即執行發布異動詮釋資料。使用授權 API KEY 呼叫「政府資料開放平臺」異動資料集詮釋資料 API，進行新增（POST）、修改（PUT）、下架（DELETE）於「政府資料開放平臺」之資料集詮釋資料。

(3) 記錄發布回傳結果，若有錯誤訊息，請參考錯誤處理程序，並於錯誤排除後進行重新發布。

2. 定期發布模式

各資料開放平臺定期檢查詮釋資料異動狀況，發現有異動時，呼叫政府資料開放平臺之資料異動 API，進行異動發布。各資料開放平臺定期發布詮釋資料流程如下圖所示。

圖- 2 各資料開放平臺定期發布詮釋資料

各資料開放平臺定期發布詮釋資料流程說明如下：

(1) 各資料開放平臺管理者登入「政府資料開放平臺」系統後端管理介面申請跨平臺介接服務，「政府資料開放平臺」管理者審核通過後，設定其資料發布來源 IP，並提供授權 API KEY。

(2) 各資料開放平臺設定定期發布時間，並於執行發布詮釋資料時，使用授權 API KEY 呼叫「政府資料開放平臺」異動資料集詮釋資料 API，進行新增、修改、下架於「政府資料開放平臺」之資料集詮釋資料。

(3) 記錄發布回傳結果，若有錯誤必須參考錯誤處理程序，並於錯誤排除後進行重新發布。

（二）各資料開放平臺至「政府資料開放平臺」擷取其他詮釋資料

各資料開放平臺至「政府資料開放平臺」擷取其他詮釋資料。流程如下圖：

圖- 3 各資料開放平臺至政府資料開放平臺擷取其他詮釋資料

各資料開放平臺可使用兩種作法擷取資料集詮釋資料，第一種為定期呼叫「政府資料開放平臺」之 API 擷取資料集詮釋資料至資料庫；第二種為各資料開放平臺於使用者欲查看資料集詮釋資料時，再即時呼叫「政府資料開放平臺」之 API，直接擷取該資料集詮釋資料。

若各資料開放平臺採用第一種作法，需考量詮釋資料異動時所產生之資料不一致問題，提高擷取頻率可減少資料不一致的時間。若各資料開放平臺採用第二種作法，即所謂的虛擬同步機制，不需儲存其他平臺之資料集詮釋資料於資料庫中；此機制可提供最新之詮釋資料內容予民眾，亦免除需經常性更新資料庫中其他平臺之詮釋資料，可降低維護成本。

二、詮釋資料交換方式

資料集詮釋資料的發布方式採用 RESTFul 網路服務呼叫方式，以 HTTP POST 呼叫新增詮釋資料、以 HTTP PUT 呼叫修改詮釋資料、以 HTTP DELETE呼叫下架詮釋資料。因使用 HTTP 基本認證方式，需有授權之 API KEY，故需採用含有安全性傳輸的 HTTPS 方式進行資料傳輸。

資料集詮釋資料之呼叫 API 擷取方式必須以 HTTP GET 的方式呼叫。

三、詮釋資料內容格式

資料集詮釋資料之內容格式必須遵循「資料集詮釋資料標準指引」，資料輸出及傳回皆為 JSON 格式。

肆、附錄

一、API 參考範例：

二、固定欄位結構化資料：

三、非固定欄位結構化資料