README

forked from angryjack/beget-api

beget-api

Библиотека представляет собой обертку для удобного использования Beget.API.

Установка

Через Composer

$ composer require pecherskiy-v/beget-api

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

Инициализация

use PecherskiyV\Beget\Beget;

$beget = new Beget('login', 'password');

Общая информация по использованию

Чтобы воспользоваться определенным методом, необходимо указать секцию к которой данный метод относится.

$section = $beget->api('section');

Далее можно обращаться к любому методу из указанной секции.

$result = $section->doSomething();

Методы в данной библиотеке имеют идентичные имена с методами описанными в официальной документации Beget.API

Управление аккаунтом

$user = $beget->api('user');
// получить информацию об аккаунте
$accountInfo = $user->getAccountInfo();

Все методы из данной категории доступны на официальном сайте.

Управление бекапами

$backup = $beget->api('backup');
// получить доступный список резервных файловых копий.
$backupList = $backup->getFileBackupList();

Все методы из данной категории доступны на официальном сайте.

Управление Cron

$cron = $beget->api('cron');
// получить список всех задач CronTab.
$cronTabList = $cron->getList();

Все методы из данной категории доступны на официальном сайте.

Управление DNS

$dns = $beget->api('dns');
// получить информацию с DNS-сервера о домене.
$domainDNSInfo = $dns->getData('site.com');

Все методы из данной категории доступны на официальном сайте.

Управление FTP

$ftp = $beget->api('ftp');
// получить список дополнительных FTP-аккаунтов с их домашними директориями.
$ftpList = $ftp->getData();

Все методы из данной категории доступны на официальном сайте.

Управление MySQL

$mysql = $beget->api('mysql');
// получить список баз данных MySQL с их доступами.
$mysqlList = $mysql->getList();

Все методы из данной категории доступны на официальном сайте.

Управление сайтами

$site = $beget->api('site');
// получить список сайтов с их доменами.
$siteList = $site->getList();

Все методы из данной категории доступны на официальном сайте.

Управление доменами

$domain = $beget->api('domain');
// получить список доменов на аккаунте пользователя.
$domainList = $domain->getList();

Все методы из данной категории доступны на официальном сайте.

Управление почтой

$mail = $beget->api('mail');
// получить все почтовые ящики на заданном домене.
$mailboxList = $mail->getMailboxList('site.com');

Все методы из данной категории доступны на официальном сайте.

Сбор статистики

$stat = $beget->api('stat');
// получить информацию о средней нагрузке на сайтах пользователя за последний месяц.
$siteListLoad = $stat->getSiteListLoad();

Все методы из данной категории доступны на официальном сайте.