故宮開放政策說明

政府Open Data工作，不僅在於開放原始資料(Raw Data)之資料集(Dataset)，還提供了應用介接程式(Application Program Interface, API)，讓所開放之資料，能以易於應用和動態處理的方式提供給外界，本院參考國發會所制定之「政府資料開放進階行動方案」，於本專區提供Open API之服務。

API Key 申請

本專區所開放之 API ，均採用 API Key 作為驗證之用，使用本專區各API 前，請先於畫面右側申請驗證碼(API Key)，申請通過後，將以 e-mail 方式通知。

介接使用說明

本專區提供 RESTful Web API，使用者可採用 HTTP GET 方法，取得本專區開放資料，並以通用 JSON 格式作為回傳結果。

介接驗證

每一次叫用本專區所提供之API服務時，其驗證碼需於 HTTP Header 中傳遞，變數名稱為 apiKey，apiKey 之數值為申請後所得之驗證碼，apiKey之格式範例為：6fc459ea-ee9a-3ca4-8e43-db77e1603333。

名詞定義

{SRU}:本專區所提供API服務之根網址

https://openapi.npm.gov.tw/v1/rest/

服務結構範例

https://openapi.npm.gov.tw/v1/rest/collection/search/04000975?limit=2&offset=10&lang=cht

{SRU}: https://openapi.npm.gov.tw/v1/rest/

服務路徑：https://openapi.npm.gov.tw/v1/rest/collection/search/04000975

輸入參數：?limit=2&offset=10&lang=cht

資料回傳結構

{
    "status": 200,
    "result": [
        {
            "Serial_No": "04000967",
            "ArticleSubject": "秉燭夜遊",
            "CateGory": "繪畫",
            "Slogan": "宋",
            "art_room": ""
        }
    ],
    "error": null
}

status回傳呼叫結果(Http Status Code)

result回傳服務結果

error錯誤訊息，若沒有錯誤，回傳 null。