修改歷程紀錄

• 2023.9.18 API v2.5.1 啟用（v2.5.1僅對觀測紀錄部分作小幅度修改，相容於v2.5）
• 2022.3.14 API v2.5 啟用
• 2020.6.22 API v2.01 啟用
• 2020.1.1 API v2.0 啟用
• 2018.12 API v1.0上線

API基本說明

TBN的Open API為公開服務，對所有人開放，惟請注意：

• 為保護敏感物種，資料進行了必要的模糊化處理，若使用者有取得未模糊化資料之需求，可申請限制型 API。
• 為保護個人隱私，資料內未含有觀測者個人資料。
• API目的為供機器間自動處理，非供直接閱讀。
• 本API僅提供JSON。

API基本架構

介接方式

本API為僅使用HTTP GET protocol 的 RESTful API。

服務網址

本API的一般性服務網址為 https://www.tbn.org.tw/api/{version}/{type}?{parameters} ，其中：

{version}: API版本，本版本為v2.5，於網址中寫為v25。  
{type}: API服務類型，本版本支援occurrence、taxon與dataset三類。  
{parameters}: 查詢參數。

API服務類型

本API提供三種服務類型：

觀測紀錄查詢 occurrence

本類型提供TBN收錄觀測記錄查詢。本服務會進行部分資訊模糊化，如果你有取得模糊化資料之需求，請申請限制性API服務。

物種查詢 taxon

本類型提供TBN物種資料庫查詢服務。透過本類型服務，可以物種名（含別名）關鍵字及TBN物種UUID查詢TBN物種（含高階分類群）。本類型取得之資訊，如TBN物種UUID，可用於觀測紀錄查詢。

資料集查詢 dataset

本類型提供TBN收錄資料集查詢服務。透過本類型服務，可以資料集標題關鍵字及TBN資料集UUID取得TBN資料集資訊。本類型取得之資訊，如TBN資料集UUID，可用於觀測紀錄查詢。

共通查詢參數

分頁與筆數限制

因效能考量，本API限制單一請求至多回傳1000筆資料，你可以透過分頁參數進行多次請求以取得全部查詢資料。分頁參數為：

每次API取得之資料中，如有下一分頁資料，會包含取得下一分頁之網址，可用該網址遞迴取得全部資料。

回傳格式

本API回傳符合條件的JSON結果物件（Object），其回傳格式為：

{
    "meta": {
        "total": (int)符合查詢條件全部筆數
    },
    "links": {
        "self": (string)本頁網址,
        "next": (string)下一分頁網址
    },
    "data": (Array) [結果陣列],
}

使用規範

本API採「政府資料開放授權條款」授權公眾使用。

後續發展

TBN API以開放並盡可能釋出原始資料為目標。對本API有任何建議，請不吝告訴我們。