本資料開放服務平臺提供開發人員可以使用API開發程式方式自動取得平臺上的開放資料使用及加值

  1. 平臺的開發標準:

    本平臺的API開發標準,依循國發會於民國104年7月所頒布的「共通性資料存取應用程式介面(API)規範」為設計準則。

  2. 平臺資料集的詮釋資料標準:

    本平臺的資料集詮釋資料 ,依循國發會於民國104年7月所頒布的「資料集詮釋資料標準規範」為設計準則。

  3. API的分類及使用:

    本平臺的API依據規範設計了八個API,依功能性不同可分為二大類,第一部分為依資料集詮釋資料的不同角度或分類的方式查詢相關資料集或直接使用已知的資料集透過序號編號方式真接取得特定資料集的相關資訊及描述;另一部分則是特定資料集的實體資料的取得以下為此二部分清單及各別描述使用方法:

    1. 資料集的詮釋資料之取得
      • 取得分類群組清單
      • 取得群組相關的資料集編號
      • 取得標籤清單
      • 取得標籤相關的資料集編號
      • 取得資料集編號清單
      • 取得資料集詮釋資料
    2. 資料集的資料資源內容取得
      • 取得資料集之資料資源內容
      • 下載資料集之資料資源全部內容

取得分類群組清單

  1. 使用說明:

    使用API取得平臺上符合條件之資料集分類編號(categoryCode)

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/group?limit={limit}&offset={offset}

    {limit}:限制最多回傳的資料筆數。預設值: 100

    {offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/group

    範例2:http://data.nhi.gov.tw/api/v1/rest/group?limit=5&offset=0

  4. 輸出格式:JSON
  5. 備註:
    1. 分類編號(categoryCode)為本平臺上之資料分類編號共有2碼第1碼為大分類,第二碼為各分類細項
    2. 此輸出範例的分類編號為本平臺之資料集詮釋資料之分類編號。

取得群組相關的資料集編號

  1. 使用說明:

    使用API取得平臺上符合條件之群組相關的資料集編號

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/group/{categoryCode}

    {categoryCode}:分類編號

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/group/00

  4. 輸出格式:JSON
    • categoryCode:群組的分類編號
    • display_name:用來顯示的分類群組名稱
    • description:描述分類群組詳細內容
    • package_count:群組內資料集數量
    • created:建立日期
    • packages:群組內資料集編號清單

取得標籤清單

  1. 使用說明:

    使用API取得平臺上符合條件之標籤清單

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/tag?limit={limit}&offset={offset}

    {limit}:限制最多回傳的資料筆數。預設值: 100

    {offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/tag

    範例2:http://data.nhi.gov.tw/api/v1/rest/tag?limit=5&offset=0

  4. 輸出格式:JSON
  5. 備註:

    標籤(tag)為各資料集紀錄於資料集詮釋資料中的標籤/關鍵字(keyword)。

取得標籤相關的資料集編號

  1. 使用說明:

    使用API取得平臺上符合條件之標籤相關的資料集編號

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/tag/{tagName}?limit={limit}&offset={offset}

    {tagName}:標籤

    {limit}:限制最多回傳的資料筆數。預設值: 100

    {offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。預設值: 0

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/tag/醫材

    範例2:http://data.nhi.gov.tw/api/v1/rest/tag/醫材?limit=5&offset=0

  4. 輸出格式:JSON
  5. 備註:
    1. 標籤(tag)為資料集詮釋資料中的標籤/關鍵字(keyword)。
    2. tagName可經由「取得標籤清單」API項目來取得。

取得資料集編號清單

  1. 使用說明:

    使用API取得平臺上符合條件之資料集編號清單

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/dataset?modified={modified}&limit={limit}&offset={offset}

    {modified}:日期, 詮釋資料最後更新時間大於或等於輸入之查詢條件。若無輸入,則傳回所有資料集編號清單。日期格式為 yyyy-MM-dd HH:mm:ss

    {limit}:限制最多回傳的資料筆數。

    {offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/dataset

    範例2:http://data.nhi.gov.tw/api/v1/rest/dataset?limit=5&offset=0

  4. 輸出格式:JSON
  5. 備註:
    1. 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼。
    2. 輸出內容之資料集編號相等於資料集詮釋資料的資料集編號。

取得資料集詮釋資料

  1. 使用說明:

    使用API取得平臺上符合條件之資料集詮釋資料

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/dataset/{identifier}

    {identifier}:資料集編號

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/rest/dataset/A21030000I-B10001

  4. 輸出格式:JSON
  5. 備註:
    1. 輸出內容之資料集編號(identifier)指的是資料集的資訊辨識編碼。相等於資料集詮釋資料的資料集編號。
    2. 資源路徑之資料集編號可以從「取得資料集標號清單」、「取得群組相關的資料集編號」、「取得標籤相關的資料集編號」等API項目中取得

取得資料集之資料資源內容

  1. 使用說明:

    使用API取得平臺上符合條件之資料資源的資料內容

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/rest/datastore/{resource ID}?limit={limit}?=offset={offset}

    {identifier}:資料集的資料資料資源編號

    {limit}:限制最多回傳的資料筆數。

    {offset}:指定從第幾筆後開始回傳, 可與limit配合使用達到分頁目的。

  3. 輸入範例:範例1:http://data.nhi.gov.tw/api/v1/rest/datastore/A21030000I-D20007-001
  4. 輸出格式:JSON

下載資料集之資料資源全部內容

  1. 使用說明:

    使用API取得平臺上符合條件之資料資源的資料全部內容並壓縮傳回

  2. 介接網址:

    http://data.nhi.gov.tw/api/v1/dump/datastore/{resource ID}

    {identifier}:資料集的資料資料資源編號

    {format}:傳回的資料格式,無預設格式時,傳回CSV格式並壓縮成ZIP檔案傳回

  3. 輸入範例:

    範例1:http://data.nhi.gov.tw/api/v1/dump/datastore/A21030000I-E30011-001

  4. 輸出格式:ZIP