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 返回