TaiEOL API – V2
此文件為 TaiEOL Open API 版本 V2 之說明文件,是用以取得目前TaiEOL之資料。
欲使用本服務請先詳閱使用條款,並進行API Key 申請
本服務計有 2 項 API,並提供格式及共同參數說明。
- 物種多媒體 API
- 物種解說 API(尚未開放)
其他說明
物種多媒體 API
- 數位物件
- 範例:api/v2/{dataType}/{id類型}/{id}
- 說明:回傳物種分類標註到此{id}之下的所有多媒體(包含下向所有階層)
- dataType:taieol_object:回應當前id的數位物件(muse_obj)
- id類型:
- tid:TaiEOL(ASCDC)內部使用學名骨幹ID,可與物種頁面(taxon page)直接對應
- taxon_id:TaiCOL(V2) 的學名骨幹ID
- name_code:舊版taxon_id:TaiCOL的學名代碼(之後將棄用)
- 服務網址
https://data.taieol.tw/api/v2/taieol_object/tid/99628?token=hello_world
https://data.taieol.tw/api/v2/taieol_object/taxon_id/t0085379?token=hello_world
https://data.taieol.tw/api/v2/taieol_object/name_code/341781?token=hello_world
物種多媒體 API 參數說明
查詢參數 |
說明 |
範例網址 |
scientificName ={string} |
取得指定學名的藏品資料 |
|
common_name ={string} |
中文俗名查詢 |
|
回傳欄位說明
參數 | 名稱 | 型值 | 備註 | |
OID |
物件ID |
string |
等同開放博物館藏品ID |
|
created |
建立時間 |
date |
該物件在平台建立的時間 | |
modified |
更新時間 |
date |
該物件被更新的時間(有時是Metadata修正,較多時候是因應物種名錄更新的分類變動而更新) |
|
rightsHolder |
數位物件典藏者 |
string |
資料發布的來源資料庫,可能包含臺灣生命大百科以外其他開放資料集 |
|
datasetName |
資料集名稱 |
string |
資料集或提供來源的單位名稱,這資訊主要為提供圖資的來源單位或個人。 |
|
sourceName |
來源名稱 |
string |
原始資料註記的來源名稱,這資訊主要為圖資的提供者欄位原始資訊 |
|
associateMedia | 個別多媒體檔案資料 | array | 重要:每個多媒體物件可能有多個多媒體檔案的情況,實際使用的授權與引用資訊會跟隨 associatedMedia , 使用時請務必依循 associatedMedia 的資訊。 | |
url | 圖片URL | string | 圖片開放存取的網址 | |
licence | 授權條款訊息 | string | 該授權條款的說明網址 | |
authors | 此數位檔案的作者資訊 | string | 此數位檔案原始的作者欄位資訊,一般為該物件的所有權人 | |
citation | 引用資訊 | string | 依據授權條款凡有姓名標示需求請務必清楚標註此引用資訊,每個數位檔案(associateMedia)會有各自對應引用資訊 | |
scientificNameID |
物種代碼 |
int |
TaiEOL(ASCDC)內部使用學名骨幹ID,可與物種頁面(taxon page)直接對應 |
|
taieolTaxonPage |
對應的物種頁面URL |
string |
所屬物種分類對應臺灣生命大百科的物種頁面URL |
|
permanentLink |
數位物件連結 |
string |
此數位物件的永久連結 |
|
scientificName |
學名 |
string |
目前對應後的物種學名 |
|
taxonRank |
分類層級 |
string |
目前對應後的有效物種分類層級 |
|
taxonID |
物種編號 |
string |
新版TaiCOL物種編號 |
|
isPreferredName |
中文名與其他別名 |
string |
多值以逗號,分隔 |
|
speciesPictureClassification |
物種圖片分類 |
string |
TaiEOL自訂的多媒體分類,目前允許值為生態照、標本照、手繪圖等,可能為空值也會隨需求擴充 |
格式及共同參數說明
- 本API回傳格式為JSON。
- 各參數可用「&」相互組合,但可能因性質而異。
回傳狀態(status)代碼說明:
代碼(code) |
訊息(message) |
說明 |
200 |
Success |
成功 |
500 |
Please apply for an official token |
請填入Token資訊 |
分頁參數說明:
參數 |
說明 |
範例網址 |
page |
指定回傳起始編號。預設為1 |
|
per_page |
限制回傳筆數。預設20筆,上限200 |
|
回傳格式:
{ "meta": { "total": 65025, //(int)符合查詢條件全部筆數 "page": 1, //(int)回傳起始編號 "per_page": 10 //(int)回傳筆數 }, ... }
使用規範
- 本API 使用條款
- 預設的限制條件,來源IP一天可以查詢100次,一分鐘可以查詢10次,每次限制最多可以查詢200筆,合作夥伴的Token不受此項限制。
- 如果您使用Python抓取API的資料,關於Python引擎的用戶設定,請不要使用預設值,系統會判定為爬蟲而進行防禦。
更新紀錄
- 2024-06-12 | V2公告