README

UpDown.io PHP SDK

文档

现在您可以在 此处 找到完整的文档

框架

• Laravel 5 包

入门

首先您需要一个 UpDown.io 账户。

更多信息/文档将尽快准备就绪。

安装

您可以通过 composer 安装此包

composer require biscolab/updown-php-sdk

配置

API 密钥

首先您需要一个 API 密钥：获取 API 密钥

初始化 UpDown 并创建 Check 对象

use Biscolab\UpDown\UpDown;
use Biscolab\UpDown\Objects\Check;
use Biscolab\UpDown\Fields\UpDownRequestFields;

// Initialize UpDown 
UpDown::init([
    UpDownRequestFields::API_KEY => '<YOUR_UPDOWN_API_KEY>'
]);

// Create an empty "Check" CRUD object 
$check = new Check();

// OR

// Create an existing "Check" CRUD object 
$check = new Check($attributes);

• $check 是一个 CRUD 对象，因此它具有 create、read、update 和 delete 方法。
• $attributes 可以是一个包含属性列表（Biscolab\UpDown\Fields\CheckFields）的数组或一个表示由 updown.io 给出的令牌的标量值。

用法

在 updown.io 上创建 Check 对象

$check = new Check($attributes);
$check->create();

从 updown.io 读取 Check 数据

$check = new Check($token);
$check->read();

// get data as array
$array_data = $check->toArray();

// get single value
$url = $check->{UpDownRequestFields::URL};

使用 Enum 值如 UpDownRequestFields 以避免错误

在 updown.io 上更新 Check

$check = new Check($token);
$check->update($attributes);

从 updown.io 删除 Check

$check = new Check($token);
$deleted = $check->delete();

• $deleted 是布尔值，true 表示“成功”，false 表示出错

从 updown.io 获取 Check “Metrics”

$check = new Check($token);
$metrics = $check->getMetrics($from, $to, $group);

• $metrics 是一个 Biscolab\UpDown\Types\Metrics 类的实例

从 updown.io 获取 Check “Downtimes”

$check = new Check($token);
$downtimes = $check->getDowntimes($page);

• $downtimes 是一个 Biscolab\UpDown\Types\DownTimes 类的实例，它是一个包含 Biscolab\UpDown\Types\DownTime 对象的集合

许可证