geocodio/uptimerobot-api-client

UptimeRobot服务API的客户端

1.2.0 2021-08-25 07:07 UTC

This package is auto-updated.

Last update: 2024-08-25 15:00:29 UTC


README

轻松使用网站监控服务UptimeRobot的API。

需求

此软件包需要PHP 7+,并使用cUrl。

安装

此软件包可以在任何PHP项目中或与任何框架一起使用。软件包已在PHP 7.0中进行测试。

您可以通过composer安装此软件包

composer require vdhicts/uptimerobot-api-client

用法

此软件包只是使用UptimeRobot API的一个简单客户端。有关请求的更多信息,请参阅API文档

快速使用

use Vdhicts\UptimeRobot\Client;

// Load the configuration once, the URL is optional
$configuration = new Client\Configuration('API_KEY', 'OPTIONAL_API_URL');

// Start the client once
$client = new Client\Client($configuration);

// Perform the request, returns a string for further processing
$response = $client->perform('getMonitors', ['monitors' => '15830-32696-83920']);

输出格式

UptimeRobot API支持XML和JSON作为输出格式,此客户端也是如此。这可以通过客户端的perform方法的第三个参数进行更改。

异常

当出现问题时,客户端将抛出一个异常,该异常扩展了UptimeRobotClientException。如果您想捕获此软件包的异常,那就是您应该捕获的异常。API的错误响应不会被捕获,因此请对响应持怀疑态度处理。

贡献

欢迎任何贡献,但它应符合PSR-2标准,并请为每个功能创建一个pull request。作为交换,您将在本页上获得贡献者认可。

许可证

此软件包是开源软件,根据MIT许可证授权。

关于vdhicts

Van der Heiden ICT services是我的个人公司名称,我在那里作为自由职业者工作。Van der Heiden ICT services为企业和教育机构开发和实施IT解决方案。