機關發布開發指引 - 政府資料開放平臺

文章推薦指數： 80 %
投票人數：10人

「詮釋資料提供機關」呼叫「政府資料開放平臺」的異動資料集詮釋資料API進行發布異動 ... "description":"集中列示於政府資料開放平台資料集之詮釋資料，包含資料集 ... 機關發布開發指引:::機關發布開發指引詮釋資料提供機關申請IP和APIKey 詮釋資料提供機關可於「政府資料開放平臺」M2M專區下載 「資料開放跨平臺介接機關服務申請表」， 營運團隊會於系統後臺的跨平臺介接設定登錄相關資訊。

詮釋資料提供機關於本身「機關資料開放平臺」上使用即時或定期發布功能「詮釋資料提供機關」呼叫「政府資料開放平臺」的異動資料集詮釋資料API進行發布異動詮釋資料。

使用異動資料集詮釋資料API時，必須配合所設定之資料來源IP和APIKey使用。

呼叫新增、刪除、修改詮釋資料的API時， 需使用HTTP基本認證（HTTPBasicAuthentication）以確認授權身分，即在HTTPheader裡 設定屬性Authorization的值為APIKey。

【APIv1版】【APIv2版】異動資料集詮釋資料APIv1新增詮釋資料修改詮釋資料刪除詮釋資料新增詮釋資料(v1)使用說明：新增詮釋資料介接網址：/api/v1/rest/datasetMethod=POST輸入範例：範例1：/api/v1/rest/dataset輸入格式：JSON輸入說明：資料集詮釋資料的欄位與內容{"categoryCode":"I00","identifier":"A41000000G-000001","title":"政府資料開放平臺資料集清單","description":"集中列示於政府資料開放平台資料集之詮釋資料，包含資料集名稱、檔案格式、下載連結、資料集類型、資料集描述、主要欄位說明、資料集提供機關、更新頻率、授權方式、授權說明網址、計費方式、編碼格式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註等","fieldDescription":"資料集名稱、檔案格式、下載連結、資料集類型、資料集描述、主要欄位說明、資料集提供機關、更新頻率、授權方式、授權說明網址、計費方式、編碼格式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註","type":"rawData","license":"政府資料開放授權條款－第1版","licenseURL":"/license","cost":"免費","costURL":"","costLaw":"","organization":"國家發展委員會","organizationContactName":"袁小美","organizationContactPhone":"02-21234567","organizationContactEmail":"[email protected]","publisher":"國家發展委員會","publisherContactName":"林小美女士","publisherContactPhone":"02-21234567","publisherContactEmail":"[email protected]","publisherOID":"2.16.886.101.20003.20069","publisherOrgCode":"A41000000G","accrualPeriodicity":"每日","temporalCoverageFrom":"2014-04-0400:00:00","temporalCoverageTo":"2014-04-0400:00:00","issued":"2013-11-0100:00:00","modified":"2015-05-2911:46:53","spatial":"臺灣","language":"","landingPage":"http://www.ndc.gov.tw/m1.aspx?sNo=0027915#.VWfgxFyqqko","keyword":["政府資料開放","政府資料開放平臺","資料集","資料集詮釋資料","OpenData","OpenGovernmentData","Open","Data","Government","部會"],"numberOfData":"","notes":"","distribution":[{"resourceID":"A41000000G-000001-001","resourceDescription":"","format":"CSV","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.csv","metadataSourceOfData":"","characterSetCode":"UTF-8"},{"resourceID":"A41000000G-000001-002","resourceDescription":"","format":"JSON","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.json","metadataSourceOfData":"","characterSetCode":"UTF-8"},{"resourceID":"A41000000G-000001-003","resourceDescription":"","format":"XML","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.xml","metadataSourceOfData":"","characterSetCode":"UTF-8"}] } 輸出範例：執行成功如下所示：{"success":true,"result":{"identifier":"A41000000G-000001"}}執行失敗如下所示：{"success":false,"error":{"identifier":"A41000000G-000001""error_type":"ER0031:資料集分類錯誤","message":"無此分類categoryCode=k00"}}輸出格式：JSON備註： 資料集編號(identifier)指的是資料集的資訊辨識編碼。

相等於資料集詮釋資料的資料集編號。

可以使用詮釋資料提供機關之開放平臺上的編號。

publisherOID與publisherOrgCode請參考gOID網站的機關OID與機關代號: http://oid.nat.gov.tw/修改詮釋資料(v1)使用說明：修改詮釋資料介接網址：/api/v1/rest/dataset/{identifier}Method=PUT{identifier}：資料集編號輸入範例：範例1：/api/v1/rest/dataset/A41000000G-000001輸入格式：JSON輸入說明：資料集詮釋資料的欄位與內容{"categoryCode":"I00","identifier":"A41000000G-000001","title":"政府資料開放平臺資料集清單","description":"集中列示於政府資料開放平台資料集之詮釋資料，包含資料集名稱、檔案格式、下載連結、資料集類型、資料集描述、主要欄位說明、資料集提供機關、更新頻率、授權方式、授權說明網址、計費方式、編碼格式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註等","fieldDescription":"資料集名稱、檔案格式、下載連結、資料集類型、資料集描述、主要欄位說明、資料集提供機關、更新頻率、授權方式、授權說明網址、計費方式、編碼格式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註","type":"rawData","license":"政府資料開放授權條款－第1版","licenseURL":"/license","cost":"免費","costURL":"","costLaw":"","organization":"國家發展委員會","organizationContactName":"袁小美","organizationContactPhone":"02-21234567","organizationContactEmail":"[email protected]","publisher":"國家發展委員會","publisherContactName":"林小美女士","publisherContactPhone":"02-21234567","publisherContactEmail":"[email protected]","publisherOID":"2.16.886.101.20003.20069","publisherOrgCode":"A41000000G","accrualPeriodicity":"每日","temporalCoverageFrom":"2014-04-0400:00:00","temporalCoverageTo":"2014-04-0400:00:00","issued":"2013-11-0100:00:00","modified":"2015-05-2911:46:53","spatial":"臺灣","language":"","landingPage":"http://www.ndc.gov.tw/m1.aspx?sNo=0027915#.VWfgxFyqqko","keyword":["政府資料開放","政府資料開放平臺","資料集","資料集詮釋資料","OpenData","OpenGovernmentData","Open","Data","Government","部會"],"numberOfData":"","notes":"","distribution":[{"resourceID":"A41000000G-000001-001","resourceDescription":"","format":"CSV","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.csv","metadataSourceOfData":"","characterSetCode":"UTF-8"},{"resourceID":"A41000000G-000001-002","resourceDescription":"","format":"JSON","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.json","metadataSourceOfData":"","characterSetCode":"UTF-8"},{"resourceID":"A41000000G-000001-003","resourceDescription":"","format":"XML","resourceModified":"2015-02-2517:51:29","downloadURL":"https://file.data.gov.tw/opendatafile/政府資料開放平臺資料集清單.xml","metadataSourceOfData":"","characterSetCode":"UTF-8"}] } 輸出範例：執行成功如下所示：{"success":true,"result":{"identifier":"A41000000G-000001"}}執行失敗如下所示：{"success":false,"error":{"identifier":"A41000000G-000001""error_type":"ER0050:欲修改的資料集不存在","message":"欲修改的資料集不存在"}}輸出格式：JSON備註： 資料集編號(identifier)指的是資料集的資訊辨識編碼。

相等於資料集詮釋資料的資料集編號。

可以使用詮釋資料提供機關之開放平臺上的編號。

publisherOID與publisherOrgCode請參考gOID網站的機關OID與機關代號: http://oid.nat.gov.tw/刪除詮釋資料(v1)使用說明：刪除詮釋資料介接網址：/api/v1/rest/dataset/{identifier}Method=DELETE{identifier}：資料集編號輸入範例：範例1：/api/v1/rest/dataset/A41000000G-000001輸出範例：執行成功如下所示：{"success":true,"result":{"identifier":"A41000000G-000001"}}執行失敗如下所示：{"success":false,"error":{"identifier":"A41000000G-000001""error_type":"ER0060:欲刪除的資料集不存在","message":"欲刪除的資料集不存在"}}輸出格式：JSON備註： 資料集編號(identifier)指的是資料集的資訊辨識編碼。

相等於資料集詮釋資料的資料集編號。

可以使用詮釋資料提供機關之開放平臺上的編號。

異動資料集詮釋資料APIv2新增詮釋資料修改詮釋資料下架詮釋資料新增詮釋資料(v2)使用說明：新增詮釋資料介接網址：/api/v2/rest/datasetMethod=POST輸入範例：範例1：/api/v2/rest/dataset輸入格式：JSON輸入說明：資料集詮釋資料的欄位與內容{"categoryTheme":"001","categoryService":"I00","categoryDataset":"A","identifier":"A41000000G-000001","title":"政府資料開放平臺資料集清單","description":"集中列示於政府資料開放平臺資料集之詮釋資料式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註等","license":"1","cost":"free","dataProvider":"loginaccount","publisherOID":"2.16.886.101.20003.20069.20001|國家發展委員會檔案管理局","publisherContactName":"秘書室林小姐","publisherContactPhone":"02-23165300#XXX","publisherContactEmail":"[email protected]","updateFrequency":"每日","detectFrequency":"everyday","coverageStartedDate":"2014-01-01","coverageEndedDate":"2015-01-01","spatialCoverage":"A6305-0001-00","language":"zh","relatedUrl":"https://example1.gov.tw","keyword":["OpenData","全部資料集"],"notes":"集中於政府資料開放平臺資料集之詮釋資料","distribution":[{"resourceDescription":"103年01月01日開始收錄","resourceField":"村名(name)、人口(population)","qcLevel":"/Document/definition/dataset","resourceFormat":"CSV","resourceCharacterEncoding":"UTF-8","resourceDownloadUrl":"https://data.gov.tw/datasets/export/csv","resourceFormat":"CSV","resourceAmount":"4600","resourceNotes":"統計截止到2014年12月底"}] } 輸出範例：執行成功如下所示：{"success":true,"result":{"identifier":"A41000000G-000001" "datasetId":"6564" （系統產生）}}執行失敗如下所示：{"success":false,"error":{"identifier":"A41000000G-000001""error_type":"ER0032:資料集主題分類錯誤","message":"無此分類categoryCode=k00"}}輸出格式：JSON備註： 輸入內容之資料集編號（identifier）為「詮釋資料提供平臺」發布資料集的資訊編號，由「詮釋資料提供平臺」自行輸入。

提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 http://oid.nat.gov.tw/ ，為提供機關物件識別碼（OID），也可為下屬機關之OID，建立後則不得再修改。

資料集識別碼（datasetId）為「政府資料開放平臺」系統自動產出流水號，作為識別資料集之唯一值，不得重複與修改。

新增詮釋資料完成後，系統會回傳此識別碼。

修改詮釋資料(v2)使用說明：修改詮釋資料介接網址：/api/v2/rest/dataset/{datasetId}Method=PUT{datasetId}：資料集識別碼輸入範例：範例1：/api/v2/rest/dataset/6564輸入格式：JSON輸入說明：資料集詮釋資料的欄位與內容{"categoryTheme":"001","categoryService":"I00","categoryDataset":"A","identifier":"A41000000G-000001","title":"政府資料開放平臺資料集清單","description":"集中列示於政府資料開放平臺資料集之詮釋資料式、資料集提供機關聯絡人、資料集提供機關聯絡人電話、備註等","license":"1","cost":"free","dataProvider":"loginaccount","publisherOID":"2.16.886.101.20003.20069.20001|國家發展委員會檔案管理局","publisherContactName":"秘書室林先生","publisherContactPhone":"02-23165300#XXX","publisherContactEmail":"[email protected]","updateFrequency":"每日","detectFrequency":"everyday","coverageStartedDate":"2014-01-01","coverageEndedDate":"2015-01-01","spatialCoverage":"A6305-0001-00","language":"zh","relatedUrl":"https://example1.gov.tw","keyword":["OpenData","全部資料集"],"notes":"集中於政府資料開放平臺資料集之詮釋資料","distribution":[{"resourceDescription":"103年01月01日開始收錄","resourceField":"村名(name)、人口(population)","qcLevel":"/Document/definition/dataset","resourceFormat":"CSV","resourceCharacterEncoding":"UTF-8","resourceDownloadUrl":"https://data.gov.tw/datasets/export/csv","resourceFormat":"CSV","resourceAmount":"4600","resourceNotes":"統計截止到2014年12月底"}] } 輸出範例：執行成功如下所示：{"success":true,"result":{ "datasetId":"6564" }}執行失敗如下所示：{"success":false,"error":{"datasetId":"6564","error_type":"ER0051:欲修改的資料集不存在。

","message":"欲修改的資料集不存在。

"}}輸出格式：JSON備註： 以取得資料集詮釋資料JSON格式示範，有關系統自動產出之欄位不得進行修改，例如：資料集類型（type）、 資料品質（dataQuality）、上架日期（publishedDate）、詮釋資料更新時間（modifiedDate）、 資料資源更新時間（resourceModifiedDate），無法修改。

輸入內容之資料集編號（identifier）為「詮釋資料提供平臺」發布資料集的資訊編號，由「詮釋資料提供平臺」自行輸入。

提供機關物件識別碼（publisherOID），請參考物件識別碼中心網站 http://oid.nat.gov.tw/ ，為提供機關物件識別碼（OID），也可為下屬機關之OID，建立後則不得再修改。

資料集識別碼（datasetId）為「政府資料開放平臺」系統自動產出流水號，作為識別資料集之唯一值，不得重複與修改。

下架詮釋資料(v2)使用說明：下架詮釋資料介接網址：/api/v2/rest/dataset/{datasetId}Method=DELETE{datasetId}：資料集識別碼輸入範例：範例1：/api/v2/rest/dataset/6564輸出範例：執行成功如下所示：{"success":true,"result":{"datasetId":"6564"}}執行失敗如下所示：{"success":false,"error":{"datasetId":"6564""error_type":"ER0052:欲下架的資料集不存在。

","message":"欲下架的資料集不存在。

"}}輸出格式：JSON備註： 資料集下架即為永久下架，不得再重新上架。

詮釋資料同步下架完成，即同步移除其資料集編號（identifier）。

回頂端

請為這篇文章評分？

延伸文章資訊