redirex/redirex-php

This package is abandoned and no longer maintained. No replacement package was suggested.

The Redirex SDK provides methods for all API functions.

dev-master 2015-12-03 10:39 UTC

Requires

• guzzle/guzzle: <4.0,>=3.8

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• Ozimok Oleg

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'a, в вашем приложении, чтобы автоматически загрузить SDK Redirex в вашем проекте:

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

Использование

Вот как отправить письмо с помощью SDK:

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

# Теперь составьте и отправьте ваше письмо.
$mg->sendMessage($domain, array('from'    => '[e-mail]', 
                                'to'      => '[e-mail]', 
                                '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: [e-mail] → [e-mail] 'Hello'"
        ["type"]=>
        string(4) "info"
        ["message_id"]=>
        string(46) "[e-mail]"
      }
    }
  }
}

Отладка

Отладка PHP SDK может быть очень полезной, когда вещи работают не совсем правильно. Для отладки SDK есть несколько советов:

Укажите адрес API Redirex в Postbin. В Postbin - это веб-сервис, позволяющий вам отправлять данные и отображать результат в браузере. Это позволяет быстро определить, то, что фактически передаётся в Redirex API.

Шаг 1 - Создайте новый Postbin.
Откройте http://bin.redirex.ru. В Postbin будет создан специальный URL. Сохраните этот URL-адрес.

Шаг 2 - Создайте экземпляр клиента Redirex с помощью Postbin.

Подсказка: bin идентификатор будет находится в URL-адресе после bin.redirex.ru. Это случайно сгенерированный набор букв и цифр. Например, bin идентификатором в этом URL-адресе, http://bin.redirex.ru/dgjuy5h3, является "dgjuy5h3".

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

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

Дополнительная информация

Примеры использования для каждого метода API, вверху страницы в нашей официальной документации.

Этот пакет SDK включает построитель писем, пакетный отправщик писем и обработчик Opt-In.

Построитель писем позволяет быстро создавать массив параметров, необходимых для отправки писем, путем вызова методов для каждого параметра. Пакетный отправщик писем является расширением 'построителя писем' и позволяет легко создавать задания на отправку писем в течение нескольких секунд. Сложность пакетного обмена писем устранены!

Поддержка и обратная связь

Не забудьте посетить официальный веб-сайт документации Redirex для получения дополнительной информации о нашем API.

Если вы нашли ошибку, пожалуйста, отправьте вопрос напрямую в Github. Redirex-PHP вопросы

Как всегда, если вам нужна дополнительная помощь, то отправьте нам письмо на [e-mail].