Содержание:
Объект работы с Партнерской программой
Доступ к объекту:
POST https://api.sweb.ru/vh/partnerProgram
Методы
index(): array
Получает информацию о партнере и его характеристики.
Возвращаемые значения в свойствах объекта:
'isPartner' bool Является партнером
'contractNumber' string Номер договора
'contractDate' string Дата договора
'promocode' string Промокод
'isVerified' bool Верифицирован
'isContractSigned' bool Договор подписан
'balance' float Баланс
'sitesCount' int Количество сайтов
'clientsActiveCount' int Количество активных клиентов
'clientsTestCount' int Количество клиентов на тестовом периоде
'clientsBlockCount' int Каоличество заблокированных клиентов
'requisitesFilled' bool Реквизиты заполнены
Returns
array —
createOrderVh(string $email $email, int $tariffId $tariffId, int $period = 1 $period = 1, ?string $login = $login = null null, ?string $password = null $password = null) : array|\JsonRPC2\Response\ExtendedResult\Error
Создание заказа для стандартных тарифных планов.
Возвращаемые значения в свойствах объекта:
login string Логин
password string Пароль
Parameters
string
|
$email
|
Email
|
int
|
$tariffId
|
ID тарифного плана
|
int
|
$period
|
Период оплаты
|
?string
|
$login
|
Желаемый логин (необязательно)
|
?string
|
$password
|
Желаемый пароль (необязательно)
|
Throws
\Exception
Returns
array|\JsonRPC2\Response\ExtendedResult\Error —
checkLogin( $login $login) : bool
Проверка логина для нового пользователя.
Returns
bool —
createOrderVip(string $email $email, int $tariffId $tariffId, int $period = 1 $period = 1, ?string $login $login = null = null, ?string $password = null $password = null) : array|\JsonRPC2\Response\ExtendedResult\Error
Создание заказа для VIP тарифных планов.
Возвращаемые значения в свойствах объекта:
login string Логин
password string Пароль
Parameters
string
|
$email
|
Email
|
int
|
$tariffId
|
ID тарифного плана
|
int
|
$period
|
Период оплаты
|
?string
|
$login
|
Желаемый логин (необязательно)
|
?string
|
$password
|
Желаемый пароль (необязательно)
|
Throws
\Exception
Returns
array|\JsonRPC2\Response\ExtendedResult\Error —
createOrderVps(string $email $email, int $tariffId $tariffId, int $distributiveId $distributiveId, int|null $p$p eriod = 1 eriod = 1, string|null $login = null $login = null, string|null $password = null $password = null, int|null $datacenter = Datacenter::SPB $datacenter = Datacenter::SPB) : array|\JsonRPC2\Response\ExtendedResult\Error
Создание заказа для VPS тарифных планов.
Возвращаемые значения в свойствах объекта:
login string Логин
password string Пароль
Parameters
string
|
$email
|
Email
|
int
|
$tariffId
|
ID тарифного плана
|
int
|
$distributiveId
|
ID дистрибутива ОС из vpsOsConfig
|
int|null
|
$period
|
Период оплаты
|
string|null
|
$login
|
Желаемый логин (необязательно)
|
string|null
|
$password
|
Желаемый пароль (необязательно)
|
int|null
|
$datacenter
|
Датацентр
|
Throws
\Exception
Returns
array|\JsonRPC2\Response\ExtendedResult\Error —
standardPlans() : array
Получение списка доступных стандартных тарифов.
Возвращаемые значение в элементах массива:
id int ID тарифа
name string Название
sites int Количество сайтов
disk int Место в ГБ
dbCount int Количество баз данных >=512 = бесконечность
mailCount int Количество почтовых ящиков >=1024 = бесконечность
ftpCount int Количество FTP-аккаунтов >=1024 = бесконечность
period array периоды оплаты
-
length int Период в месяцах
-
price int Стоимость за период
-
ssl int Количество SSL в подарок
-
domain int Количество доменов в подарок
-
domainZone string Доменные зоны, которые идут в подарок
Throws
\Exception
Returns
array —
vipPlans() : array
Получение списка доступных стандартных тарифов.
Возвращаемые значение в элементах массива:
id int ID тарифа
name string Название
sites int Количество сайтов
disk int Место в ГБ
dbCount int Количество баз данных >=512 = бесконечность
mailCount int Количество почтовых ящиков >=1024 = бесконечность
ftpCount int Количество FTP-аккаунтов >=1024 = бесконечность
period array периоды оплаты
-
length int Период в месяцах
-
price int Стоимость за период
-
ssl int Количество SSL в подарок
-
domain int Количество доменов в подарок
-
domainZone string Доменные зоны, которые идут в подарок
Throws
\Exception
Returns
array —
vpsOsConfig() : array
Получение списка доступных дистрибутивов, ISP-лицензий, тарифных планов.
Возвращаемые значения в элементах массива:
'vpsPlans' array Тарифные планы
'selectOs' array Операционные системы
'selectPanel' array Панели управления
'osPanel' array Дистрибутивы (операционная система+панель), параметр
'distributive' передается в createOrderVps
'datacenters' array Доступные датацентры
'categories' array Категории тарифных планов
Returns
array —
startPartnership() : int
Нажатие на кнопку "Стать партнером". Создает партнера без реквизитов.
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
int —
fillPartnerRequisites(string $inn, string $snils, string $regAddress) : int|\JsonRPC2\Response\ExtendedResult
Заполнение реквизитов партнера. Доступно только для физических лиц
Parameters
string
|
$inn
|
ИНН
|
string
|
$snils
|
СНИЛС
|
string
|
$regAddress
|
Адрес регистрации
|
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
int|\JsonRPC2\Response\ExtendedResult —
getContractPdf() : array
Запрос PDF-документа партнерского договора.
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
getCertificatePdf() : array
Запрос PDF-документа партнерского сертификата.
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
getTypesAdvertMaterials() : array
Запрос типов рекламных материалов.
Throws
\Exception
Returns
array —
getAdvertMaterials(string $type) : array|null
Возвращает все банеры указанного типа.
Throws
\JsonRPC2\Exception\ApplicationJsonExceptionReturns
Returns
array|null —
- Метод getPartnerClientsList()
getPartnerClientsList(int $filterStatus = -1, int $page = 1) : array
Получение отфильтрованных данных в виде массива с детализацией по клиентам партнера.
Возвращаемые значения в свойствах объекта:
'id' int id привлеченного клиента
'cust_login' string сокращенный логин привлеченного клиента
'ts' string дата регистрации
'plan' string название тарифного плана
'pays_month' float Начислено за последний месяц
'pays_all' float Начислено всего
'is_promo' bool промо тариф или нет. Вознаграждение начисляется, если пользователь "не промо".
'status' int 2 - статус привлеченного клиента. 0 - заблокирован; 1 - активный; 2 - тестовый
Parameters
int
|
$filterStatus
|
статус, по которому нужно отфильтровать
|
int
|
$page
|
номер страницы с 1
|
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
- Метод getPartnerClientCard()
getPartnerClientCard(string $clientId) : mixed
Получение подробной информации о клиенте.
Возвращаемые значения в свойствах объекта:
'type' string
'login' string
'id' string
'contractNumber' string
'regDate' string
'planName' string
'amountsPeriod' float
'amountsLastMonth' float
'attraction' string
'status' string
'comment' string
Parameters
string
|
$clientId
|
string MD5 логина клиента партнера
|
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
mixed —
- Метод savePartnerClientComment()
savePartnerClientComment(string $clientId, $comment) : int
Сохраняет изменение комментария к клиенту партнера
Parameters
string
|
$clientId
|
MD5 логина клиента партнера
|
|
$comment
|
|
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
int —
- Метод getPartnerClientLogEvents()
getPartnerClientLogEvents(int $page = 1) : array
Выводит лог событий по клиентам партнера с пагинацией.
Возвращаемые значения в свойствах объекта:
'list' array Список событий
'filterInfo' array Информация о странице
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
- Метод getPartnerClientLogFinance()
getPartnerClientLogFinance(int $page = 1) : array
Выводит лог детализацию по балансу по клиентам партнера с пагинацией (события, которые касаются финансов)
'list' array Список операций по балансу
'filterInfo' array Информация о странице
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
- Метод sendWithdrawalOrder()
sendWithdrawalOrder(int $orderType, float $countMoney, string $reqUserName, string $reqPayPurpose, string $reqCheckAccount = null, string $reqBankName = null, string $reqBIC = null, string $reqCorrAccount = null) : int|\JsonRPC2\Response\ExtendedResult
Отправка заказа на вывод партнерского вознаграждения.
Parameters
int
|
$orderType
|
1 - вывод на расчетный счет; 2 - вывод на баланс
|
float
|
$countMoney
|
сумма к выводу
|
string
|
$reqUserName
|
Ваши Ф.И.О. (обязательно только для физ. лица при выводе на р/с)
|
string
|
$reqPayPurpose
|
Назначение платежа
|
string
|
$reqCheckAccount
|
расчетный счет
|
string
|
$reqBankName
|
Наименование банка
|
string
|
$reqBIC
|
БИК
|
string
|
reqCorrAccount
|
К/с
|
Throws
\Exception
Returns
int|\JsonRPC2\Response\ExtendedResult —
- Метод getRequisitesWithdrawal()
getRequisitesWithdrawal() : array
Возвращает сохраненные ранее реквизиты для вывода средств. Зависит от типа аккаунта.
Throws
\JsonRPC2\Exception\ApplicationJsonException
Returns
array —
Массив с элементами 'reqCheckAccount', 'reqBankName', 'reqBIC', 'reqCorrAccount', 'reqUserName'
getStatistic(string $site, int|null $year = null, int|null $month = null) : array
Возвращает статистику по реферальным сайтам в виде графика и таблицы csv.
Parameters
string
|
$site
|
|
int|null
|
$year
|
|
int|null
|
$month
|
|
Throws
\Exception
Returns
array —