示警查詢API

什麼是「示警訊息查詢API」?
「示警查詢API」是以網路應用程式介面Web API (application programming interface) 提供各網站開發者透過程式介接取得即時示警訊息的管道,本API所提供的主要資料範疇為發布機關清單、示警名稱清單、示警訊息清單、示警內容等。
API以URL存取資料
API分為網站根目錄(App Root)、資源路徑(Resource Path)和查詢選項(Query Options):
https://Domain{Namespace}根目錄/{Service}/{Application}資源路徑?{ODataQueryOptions}查詢選項
  • 網站根目錄(App Root) :

    應用服務的基本網址,主要組成為(Domain)網域名稱,並且透過 HTTPS 協定連結而形成服務的基本網址。
    1. Domain: alerts.ncdr.nat.gov.tw
  • 資源路徑(Resource Path):

    指定資源項目路徑名稱,包括
    1. Service(服務):api
    2. Application(應用內容):包括

      ◆ 發布單位資訊(group):可以取得發布單位清單
      ◆ 示警名稱(dataset):可以取得示警名稱清單
      ◆ 示警訊息清單(datastore):可以查詢即時示警訊息清單
      ◆ 示警訊息內容(dump):可以查詢示警訊息內容

  • 查詢選項(Query Options):

    欲查詢指定資源時可用的選項條件,各介面可用的條件請參考API說明文件
如何介接「示警API」?
  • 首先,您需要進行會員註冊,完成電子郵件認證後,即可到會員專區取得APIKey API Key是由本平台產生的識別資訊,開發者在程式端需透過此金鑰進行呼叫介接
  • 接著,您可以閱讀API說明文件 開始寫程式呼叫囉 建議操作步驟:
    1. Step1. 透過發布單位資訊(group)及示警名稱(dataset)查詢“發布單位”與“示警名稱”的對應代碼
    2. Step2. 透過示警訊息清單(datastore)查詢即時示警訊息清單與capid
    3. Step3. 透過示警訊息內容(dump)以capid查詢示警訊息詳細內容