REST API 可用于在您自己的應用程序中包含監視數據和功能。

文檔和示例應用程序

交互式文檔將允許您在不需要沙盒環境的情況下測試 API。請務必在右上角輸入您的 API 密鑰。

我們還推薦本教程，介紹如何使用 Watchful 在 PHP 中構建 1 頁的應用程序。

API 接口

所有 API 請求都必須通過 HTTPS 向以下終結點發出：

https://app.watchful.net/api/v1/

通過純 HTTP 進行的調用將被重定向到 HTTPS。

API 版本顯示在端點的 URL 中，例如 /api/v1。

API 密鑰

要將 API 用于您的 Watchful 帳戶，請在 Watchful 中找到選項卡 API ，然后單擊按鈕 Request new API key 。 Settings

認證

有兩種不同的方法可以對 API 的請求進行身份驗證：

HTTP 標頭

您可以使用 http 標頭“Api-Key”將密鑰隨請求傳遞。例如：

• GET https://app.watchful.net/api/v1/sites
• "Api-Key: 6a7c274802f2344196b44c"

查詢字符串參數

注意：出于安全原因，此身份驗證方法已棄用，但仍可用于測試目的。應避免在生產應用程序中使用它。

要使用此方法驗證您的請求，只需將 API 密鑰附加到名為“api_key”的查詢字符串參數中即可。例如：

GET https://app.watchful.net/api/v1/sites?api_key=6a7c274802f2344196b44c

格式

日期和時間值的格式 YYYY-MM-DD HH:MM:SS 為 。

布爾值為 1 （true） 或 0 （false）。

搜索字段可以在 SQL 中使用 % like 和 “ ” 在 “not” 的值之前。 !

輸入始終采用 JSON 格式。

我們支持 4 種不同的輸出格式。如果未指定接受標頭，則 API 將默認返回 JSON 格式：

• XML
  • HTTP-Head 接受：application/xml
•  JSON的
  • HTTP-Head 接受：application/json
•  JSONP的
  • HTTP-Head 接受：application/json
  • 對于 JSONP，將 ？callback 參數添加到任何 GET 調用，以將結果包裝在 JSON 函數中。例如： https://app.watchful.net/api/v1/sites?callback=myfunction
•  序列 化
  • HTTP-Head 接受：text/plain

錯誤

所有狀態類型都可以是交互式文檔中的視圖。

 例子：

•  XML 返回

•  JSON 返回