README

这是 Redirex PHP SDK。该 SDK 包含与 Redirex API 交互的方法。以下是一些示例，以开始使用。更多示例请参阅我们的官方文档 http://documentation.redirex.ru

安装

要安装 SDK 包，您需要在项目中使用 Composer。如果您还没有使用 Composer，这很简单！以下是安装 Redirex SDK 和 Composer 的方法。

# Установка Composer
curl -sS https://getcomposer.org/installer | php

# Добавить Redirex как зависимость
php composer.phar require redirex/redirex-php:~1.0.0

对于没有 SSH 访问的虚拟主机，请参阅我们的虚拟服务器安装说明。

只想下载文件？下载库。

接下来需要在您的应用程序中设置 Composer 的自动加载器，以自动将 Redirex SDK 加载到您的项目中

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

使用

以下是使用 SDK 发送电子邮件的示例

# Во-первых, создайте экземпляр SDK с вашими учетными данными API и определите ваш домен.
$mg = new Redirex("key-example");
$domain = "example.ru";

# Теперь составьте и отправьте ваше письмо.
$mg->sendMessage($domain, array('from'    => 'bob@example.ru', 
                                'to'      => 'sally@example.ru', 
                                'subject' => 'Удивительный PHP SDK!', 
                                'text'    => 'Вот так просто отправленное письмо.'));

或获取最新的 25 个日志元素

# Во-первых, создайте экземпляр SDK с вашими учетными данными API и определите ваш домен.
$mg = new Redirex("key-example");
$domain = "example.ru";

# Теперь, отправить GET запрос на получения логов.
$mg->get("$domain/log", array('limit' => 25, 
                              'skip'  => 0));

响应

结果将以对象的形式提供，您可以使用它作为数组。

示例

$mg = new Redirex("key-example");
$domain = "example.ru";

$result = $mg->get("$domain/log", array('limit' => 25, 
                                        'skip'  => 0));

$httpResponseCode = $result->http_response_code;
$httpResponseBody = $result->http_response_body;

# Перебираем результаты и выводим идентификаторы писем.
$logItems = $result->http_response_body->items;
foreach($logItems as $logItem){
    echo $logItem->message_id . "\n";
}

示例内容：$httpResponseCode 将包含一个整数。您可以在我们的文档中找到我们如何使用 HTTP 响应代码：http://documentation.redirex.ru/api-intro.html?highlight=401#errors

$httpResponseBody 将包含 API 响应对象。在上面的示例中，var_dump($result) 应该包含以下内容

object(stdClass)#26 (2) {
["http_response_body"]=>
  object(stdClass)#26 (2) {
    ["total_count"]=>
    int(12)
    ["items"]=>
    array(1) {
      [0]=>
      object(stdClass)#31 (5) {
        ["hap"]=>
        string(9) "delivered"
        ["created_at"]=>
        string(29) "Tue, 20 Aug 2013 20:24:34 GMT"
        ["message"]=>
        string(66) "Delivered: me@samples.redirex.org → oleg.tukavin@gmail.ru 'Hello'"
        ["type"]=>
        string(4) "info"
        ["message_id"]=>
        string(46) "20130820202406.24739.21973@samples.redirex.org"
      }
    }
  }
}

调试

当事情不完全正确时，调试 PHP SDK 非常有用。以下是一些调试 SDK 的建议

在 Postbin 中指定 Redirex API 地址。Postbin 是一个允许您发送数据并在浏览器中显示结果的 Web 服务。这允许您快速确定实际发送给 Redirex API 的内容。

步骤 1 - 创建一个新的 Postbin。
打开 http://bin.redirex.ru。Postbin 将创建一个特殊的 URL。保存此 URL 地址。

步骤 2 - 使用 Postbin 创建 Redirex 客户端实例。

提示：bin 标识符将在 bin.redirex.ru URL 地址之后。这是一个随机生成的字母和数字组合。例如，此 URL 地址中的 bin 标识符为 "dgjuy5h3"，如下所示： http://bin.redirex.ru/dgjuy5h3。

# Во-первых, создайте экземпляр SDK с вашими учетными данными API и определите ваш домен.
$mg = new Redirex('key-example', 'bin.redirex.ru', 'dgjuy5h3', $ssl = False);
$domain = 'example.ru';

# Теперь, составьте и отправьте ваше письмо.
$mg->sendMessage($domain, array('from'    => 'bob@example.ru', 
                                'to'      => 'sally@example.ru', 
                                'subject' => 'Удивительный PHP SDK!', 
                                'text'    => 'Вот так просто отправленное письмо.'));

支持和反馈

请勿忘记访问Redirex的官方文档网站以获取关于我们API的更多信息。

如果您发现错误，请直接在Github上发送问题。Redirex-PHP 问题

一如既往，如果您需要额外帮助，请通过support@redirex.ru给我们发送邮件。

redirex / redirex-php

维护者

详细信息

README

安装

使用

响应

调试

更多信息

支持和反馈