:::

開發指引

方式一:OpenAPI Specification(OAS)

OAS藉由一致性的描述方法,提供人類及機器都可以看得懂且可直接使用的API說明文件,藉由網路間應用程式介面的共通語言,降低了資訊的溝通成本,讓服務的串聯更加便利。

 

OpenAPI Specification閱讀與測試使用請參:

本網站之開發應用/OpenAPI或點擊網址https://data.ntpc.gov.tw/openapi/swagger-ui/index.html?configUrl=/api/v1/openapi/swagger/config

 

方式二:資料下載

直接於網站中的各資料頁面,依瀏覽器使用方式點選該檔案以滑鼠右鍵下載,以URL存取資料。

 

  1. 基本查詢 (即各資料頁面內 下方之連結) 
    https://data.ntpc.gov.tw/api/datasets/{dataSetOid}/{format} 
    {dataSetOid}:資料代號。各資料頁面內,下方【取得JSON】、【取得xml】、【取得csv】連結可取得
    API介接
    {format}:資料格式。json、xml、csv 
    範例:新北市路邊停車空位查詢 
    https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/xml 

    2.進階查詢 
    目前平台提供兩種查詢條件,格式如下: 
    page:取得資料頁碼。 
    size:每頁資料筆數。 
  2. filter:關鍵字查詢,Value填寫方式「{欄位名稱}(空格)eq(空格){值} 」ex.「ID eq 5109」。
  3. 註:空格在網址會被轉成"%20"

  4. 範例一、 
    https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/xml?page=0&size=2
    說明: 
    $format=xml,代表資料格式為xml; 
    $page=0,為取得page=0,為取得第1頁資料; 
    $size=2,為取得第1頁資料前2筆資料。 
  5.  
  6. 範例二、
  7. https://data.ntpc.gov.tw/api/datasets/54A507C4-C038-41B5-BF60-BBECB9D052C6/xml?$filter=ID%20eq%205109
  8. $format=xml,代表資料格式為xml; 
  9. $filter=ID%20eq%205109,為取得「ID」為「5109」資料。
  10.  

  1. 檔案格式 
    JSON、XML、CSV 


    其他事項 
    1. 如資料內容有TWD97的欄位,當定位的正確性不夠時,系統會給予0當作定位失敗。 

    2. 『新北市公有路外停車場即時賸餘車位數』、『新北市垃圾清運車輛所在位置』為即時資料,系統每三分鐘更新資料,如您有大量及高頻率之資料介接需求時,請讓我們知道,以免因大量介接造成平台效能不彰,影響雙方作業。 

    3. 『新北市公車預估到站時間』為即時資料,系統每兩分鐘更新資料,如您有大量及高頻率之資料介接需求時,請讓我們知道,以免因大量介接造成平台效能不彰,影響雙方作業。