API 教程

At 2020-03-14 fate wrote in OpenWebMonitor. 133 viewer.

前置条件:

  • 理解HTTP请求
  • 指导HTTP请求的两种方式get/post
  • 理解在url中传递参数的格式

what's that???(黑人❓),若以上没概念,则此功能应该不是你的菜。

API功能概述

当出现提醒时,可以将提醒的内容传递给一个url地址,并在url地址参数中附带额外的提醒信息。例如:目标名称、消息、内容。

此功能可以用于将本软件链接到你的其他软件系统中。

教程

  • 进入设置,前往API
  • 勾上已开启此功能
  • 选择请求方式
  • 填写被通知的地址

被通知的地址中,有固定的内容替换关系。

地址中的{target}会被替换成提醒所在的目标的名称,例如”示例天气“。

地址中的{message}会被替换成该提醒的概要,例如”增加了30个字,减少了3字“。

地址中的{content}会被替换成该目标提醒新版本内容,例如”气温30度,北风7级“。

举个例子:

一个名称为”abc“目标,检测发现新的内容为”我就是新内容“,软件的提醒消息为”新增3个字,减少2个字“。 此时,若你的API的通知地址是http://your-address-to-receive-notification.com?fieldA={target}&fieldB={message}&fieldC={content}&fieldD=other

那么实际请求的地址为相应替换后的: http://your-address-to-receive-notification.com?fieldA=abc&fieldB=新增3个字,减少2个字&fieldC=我就是新内容&fieldD=other

注意:

  • 受限于HTTP URL PARAM的长度限制,content若超过150,则会被截断;
  • 所有字段均会被正常的uriEncode;

充分理解以上内容,设置完你的参数后,请点击测试按钮。软件会发送向你的地址发送一个测试请求,并说明结果。