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提供的token的标量值。

用法

在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};

使用枚举值如UpDownRequestFields来避免错误

在updown.io上更新Check

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

从updown.io删除Check

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

• $deleted是布尔值，如果“ok”则为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对象

许可证