greenplugin/yandex-pdd

This is simple way to use yandex pdd api

0.0.1-alpha 2017-01-16 04:01 UTC

This package is not auto-updated.

Last update: 2024-03-28 21:31:23 UTC


README

Это простой способ использовать API Yandex PDD в Вашем проекте

В законченной версии либы будут доступны все менеджеры:

  • для управления доменами
  • для управления почтовыми ящиками
  • для управления рассылками домена
  • для импорта почты
  • для управления заместителями администратора домена
  • для управления DKIM подписью
  • для управления DNS
  • для автоматической авторизации

К сожалению сейчас доступны только менеджеры:

  • Для управления доменами domainManager

Хау ту юзать?

Создание конструктора Создание менеджера.

$pdd = new Constructor('your api key');
$dm = $pdd->getDomainManager('domain.example');

Теперь можно использовать его методы.

Получить список доменов.

передаваемые параметры:

  • Страница необязательный, по-умолчанию 1, число
  • количство на странице макс: 20 необязательный, по-умолчанию 20, максимум 20, число
  • порядок сортировки необяззательный, один из двух вариантов "asc" или "desc"
		$response = $dm->get(); 

Зарегистрировать новый домен. После регистрации необходимо пройти процедуру подтверждения.

		$response = $dm->register(); 

Получить статус домена.

		$response = $dm->getStatus(); 

Получить подробную информацию о домене

		$response = $dm->getDetails(); 

Удалить домен домена.

		$response = $dm->remove(); 

Задать страну домена, от кода страны может зависить язык почтового ящика

		$response = $dm->setCountry(CountryInterface::COUNTRY_RU); 

Установить логогтип домена.

передаваемые параметры:

  • Путь до файла обязательный, строка. необходимо указывать абсолютный путь
		$response = $dm->setDomainLogo('absolute path to file'); 

Получить логотип домена.

		$response = $dm->getDomainLogo(); 

Удалить логотип домена.

		$response = $dm->removeDomainLogo(); 

Все вышеуказанные методы взвращают соотвествтующую сущность либо null

Получить подробную информацию об ошибке. Возвращает null если ошибки не было, либо текстовый код ошибки.

$error = $dm->getError();