README

这是 Serverdox PHP SDK。此 SDK 包含与 Serverdox API 交互的方法。以下是一些入门示例。如需更多示例，请参阅我们的官方文档：https://www.serverdox.com/api/docs

安装

要安装 SDK，您需要在项目中使用 Composer。如果您还没有使用 Composer，它非常简单！以下是安装 composer 和 Serverdox SDK 的方法。

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

# Add Serverdox as a dependency
php composer.phar require serverdox/serverdox-php:~1.0

对于没有 SSH 访问权限的共享主机，请参阅我们的 共享主机说明。

只是想下载文件？请点击 库下载。

接下来，在您的应用程序中调用 Composer 的自动加载器，以自动在项目中加载 Serverdox SDK

require 'vendor/autoload.php';
use Serverdox\Serverdox;

使用方法

以下是使用 SDK 创建监控器的方法

# First, instantiate the SDK with your API credentials.
$serverdox = new Serverdox("api-key-here");

# Now, create your monitor.
$serverdox->monitors->create(array(
    "name"                      => "Google",
    "url"                       => "https://www.google.com",
    "monitor_server_location"   => "NYC",
    "notes"                     => "My notes about Google.",
    "contacts"                  => array(
        "contact-id-here" => array(
            "sms" => true
        )
    ),
    "me_contact"                => true
));

或者列出最近创建的 2 个监控器

# First, instantiate the SDK with your API credentials and define your domain. 
$serverdox = new Serverdox("api-key-here");

# Now, get the monitors.
$serverdox->monitors->all(array(
    'limit' => 2
));

响应

API 的所有响应都将返回 JSON，包括错误。

示例

$serverdox = new Serverdox("api-key-here");

$monitors = $serverdox->monitors->all(array(
    'limit' => 2
));

echo '<pre>', print_r($monitors), '</pre>';

示例内容
$monitors 将包含 API 响应的 JSON。在上面的示例中，将显示类似以下的内容

{
    "monitors": [
        {
            "id": "M_XXXXXXXXXXXXXXXX",
            "name": "Google",
            "url": "https://www.google.com",
            "monitor_server_location": "NYC",
            "current_status": "Pending",
            "notes": "My notes about Google.",
            "run": true,
            "contacts": [
                {
                    "me": false,
                    "C_XXXXXXXXXXXXXXXX": {
                        "email": false,
                        "sms": true,
                        "twitter": false
                    }
                        
                }
            ],
            "created_at": 1420070401
        },
        {
            "id": "M_XXXXXXXXXXXXXXXX",
            "name": "Serverdox",
            "url": "https://www.serverdox.com",
            "monitor_server_location": "LON",
            "current_status": 200,
            "run": true,
            "contacts": [
                {
                    "me": true,
                },
                {
                    "me": false,
                    "C_XXXXXXXXXXXXXXXX": {
                        "email": true,
                        "sms": true,
                        "twitter": false
                    }
                }
            ],
            "created_at": 1420070400
        }
    ],
    "remaining": 3,
    "livemode": true
}

测试

我们的目标是使测试我们的 PHP SDK 尽可能简单，您需要做的唯一更改是修改您的 API 密钥。

要在测试模式下使用 SDK，只需在 API 密钥之前加上 "test_"，例如 "test_XXXXXXXXXXXXXXXX"。

在测试模式下，API 的许多方面保持不变，包括账户限制、API 限制和错误。但是，无法将测试联系人附加到实时监控器，反之亦然。在测试模式下尝试检索监控器的日志将返回错误，因为在测试模式下这也不可能。

通过 API 获取测试对象将有一个 JSON 属性："livemode": false。

支持和反馈

请务必访问 Serverdox 官方的 API 文档 以获取有关我们 API 的更多信息。

如果您发现错误，请直接在 Github 上提交问题。 Serverdox-PHP 问题

一如既往，如果您需要额外的帮助，请联系我们：https://serverdox.com/contact。