Файл: apidoch.php
Строк: 721
<?
session_set_cookie_params(86400);
session_start();
$full_home_path = dirname(__FILE__);
require_once($full_home_path."/_rootload.php");
mconnect();
validateUser();
if (!EnableLanguages()) { error("Can not load languages."); mclose(); exit; }
if (!GetCurrentCurrency()) { print $_lang[ErrorGetCurrentCurrency]; mclose(); exit; }
$company_name = GetSetting('company_name');
$chkProfile = GetSetting("checkprofiletype");
$profilePassportDisabled = GetSetting("profilePassportDisabled");
getfont();
if ($orderTableWidth) { $width = $orderTableWidth; } else { $width = "550"; }
if (preg_match("/^https/i",$full_www_path)) {
$full_www_path2 = preg_replace("/https/","http",$full_www_path);
} else {
$full_www_path2 = preg_replace("/http/","https",$full_www_path);
}
head('utf-8',"Описание ROOTPANEL.RU API системы управления хостингом и серверами ".$company_name);
print "<H1 class=pagetitle>Описание ROOTPANEL.RU API системы усправления хостингом и серверами ".$company_name."</H1><hr class=hr>";
?>
<H1 class=pagetitle>Содержание</H1><BR>
1. <A href=#1 class=rootlink>Введение</a><BR>
2. <A href=#2 class=rootlink>Описание HTTP шлюза</a><BR>
2.1. <A href=#2.1 class=rootlink>Реальный доступ</a><BR>
2.2. <A href=#2.2 class=rootlink>Тестовый доступ</a><BR>
3. <A href=#3 class=rootlink>Отправка HTTP запросов</a><BR>
3.1. <A href=#3.1 class=rootlink>Команды</a><BR>
3.2. <A href=#3.2 class=rootlink>Формат входных данных</a><BR>
3.3. <A href=#3.3 class=rootlink>Формат результата выполнения команды</a><BR>
3.4. <A href=#3.4 class=rootlink>Общие поля запросов</a><BR>
3.5. <A href=#3.5 class=rootlink>Сообщения об ошибках</a><BR>
3.6. <A href=#3.6 class=rootlink>Способы аутентификации</a><BR>
3.6.1. <A href=#3.6.1 class=rootlink>Аутентификация по паролю</a><BR>
3.6.2. <A href=#3.6.2 class=rootlink>Аутентификация по ключу API</a><BR>
4. <A href=#4 class=rootlink>Описание команд</a><BR>
4.1. <A href=#4.1 class=rootlink>Создание заказа</a><BR>
4.2. <A href=#4.2 class=rootlink>Продление заказа</a><BR>
4.3. <A href=#4.3 class=rootlink>Остановка заказа</a><BR>
4.4. <A href=#4.4 class=rootlink>Запуск остановленного заказа</a><BR>
4.5. <A href=#4.5 class=rootlink>Получение списка тарифных планов</a><BR>
4.6. <A href=#4.6 class=rootlink>Перезагрузка заказа</a><BR>
4.7. <A href=#4.7 class=rootlink>Переустановка заказа</a><BR>
4.8. <A href=#4.8 class=rootlink>Получение спика заказов</a><BR>
<BR>
<a name=1></a><H1 class=pagetitle>1. Введение</H1><BR>
Это справочное руководство описывает HTTP-шлюз к системе распределённой регистрации <? print $company_name?> (далее ROOTPANEL.RU API).<BR>
HTTP-шлюз — это метод взаимодействия с системой распределённой регистрации ROOTPANEL.RU API, позволяющий осуществлять операции в реальном времени за один шаг.<BR><BR>
Для осуществления одношаговых (одноэтапных) операций, вся информация должна быть представлена в одном единственном HTTP-запросе. В интерфейсе ROOTPANEL.RU API нет понятия "состояния" и все запросы независимы друг от друга. HTTP-интерфейс поддерживает такие операции как создание заказа, продление заказа, приостановка заказа, запуск заказа и т.п. Доступные операции описаны ниже в этом документе. <BR><BR>
<a name=2></a><H1 class=pagetitle>2. Описание HTTP шлюза</H1><BR>
Компания <? print $company_name?> предоставляет не только реальный доступ к HTTP-шлюзу, но также и тестовый доступ для отладки взаимодействия с системой ROOTPANEL.RU API.<BR><BR>
<a name=2.1></a><H1 class=pagetitle>2.1. Реальный доступ</H1><BR>
Запросы к HTTP-шлюзу должны направляться на URL<BR><BR>
<? print $full_www_path?>apih.php<BR><BR>
или<BR><BR>
<? print $full_www_path2?>apih.php<BR><BR>
Рекомендуется использовать безопасный SSL-протокол, если его поддерживает система.<BR>
Среднее время ответа при нормальных нагрузках сервера должно быть не более 5 или 10 секунд.<BR><BR>
<a name=2.2></a><H1 class=pagetitle>2.2. Тестовый доступ</H1><BR>
<? print $company_name?> предоставляет тестовый доступ к своему шлюзу для тестирования системы регистрации. Отличия тестового доступа от реального таковы:<BR><BR>
- Плата за операции не взимается<BR>
- Операции с заказами реально не производятся, аккаунты не создаются<BR>
- Тестовая система не содержит информации о заказах, которая присутствует в реальном реестре. <BR><BR>
Для использования тестовой системы, HTTP запросы должны направляться на тот же URL, что и для реальной системы. При этом используются следующие авторизационные данные:<BR><BR>
login: test<BR>
pass: test<BR><BR>
<a name=3></a><H1 class=pagetitle>3. Отправка HTTP-запросов</H1><BR>
<a name=3.1></a><H1 class=pagetitle>3.1. Команды</H1><BR>
HTTP-шлюз позволяет выполнять различные команды. В таблице ниже приведён список команд, которые могут быть осуществлены с использованием HTTP-шлюза. Для каждой операции требуется указание различных параметров (полей), которые описаны ниже в этом документе.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Команда</B><BR>(значение command)</td><td><B>Описание</b></td></tr>
<tr valign=top class="<? print $font_row1?>"><td>createOrder</td><td>Создание заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>renewOrder</td><td>Продление заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>suspendOrder</td><td>Остановка заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>unSuspendOrder</td><td>Запуск остановленного заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>getTarifs</td><td>Получение списка тарифных планов</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>restartOrder</td><td>Перезагрузка заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>reinstallOrder</td><td>Переустановка заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>getOrders</td><td>Получение списка заказов</td></tr>
</table><BR>
<a name=3.2></a><H1 class=pagetitle>3.2. Формат входных данных</H1><BR>
Команды передаются в виде стандартного запроса HTTP/1.0 методом POST или GET. Параметры команды передаются в виде HTTP параметров. При этом действуют следующие правила:<BR><BR>
- Значения всех полей являются строками.<BR>
- Значения полей передаются в кодировке utf-8.<BR>
- Все обязательные поля должны присутствовать в запросе и должны содержать как минимум один символ.<BR>
- Названия параметров HTTP-запроса должны в точности соответствовать названиям полей с учётом регистра символов.<BR>
- Значения всех полей должны быть urlencoded.<BR><BR>
<a name=3.3></a><H1 class=pagetitle>3.3. Формат результата выполнения команды</H1><BR>
Ответом интерфейса ROOTPANEL.RU API является сериализованная строка, содержащая в себе массив параметров, полученная с помощью PHP-функции serialize.<BR>
Кодировка строки ответа utf-8.<BR>
Для преобразования сериализованной строки обратно в массив параметров, необходимо использовать PHP-функцию unserialize.<BR><BR>
<a name=3.4></a><H1 class=pagetitle>3.4. Общие поля запросов</H1><BR>
В таблице перечислены все обязательные поля, которые должны присутствовать в любом запросе.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr valign=top class="<? print $font_row1?>"><td>command</td><td>Определяет команду, которая должна быть выполнена, например createOrder</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>login</td><td>Логин пользователя в биллинговой системе</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>pass</td><td>Пароль пользователя в биллинговой системе.<BR>Поля pass и apikey являются взаимоисключающими и не могут встречаться в одном запросе. См. раздел <A href=#3.6 class=rootlink>3.6.</a> </td></tr>
<tr valign=top class="<? print $font_row1?>"><td>apikey</td><td>Ключ для доступа к интерфейсу ROOTPANEL.RU API.<BR>Поля pass и apikey являются взаимоисключающими и не могут встречаться в одном запросе. См. раздел <A href=#3.6 class=rootlink>3.6.</a> </td></tr>
</table>
<a name=3.5></a><H1 class=pagetitle>3.5. Сообщения об ошибках</H1><BR>
Существует два типа ошибок - критические и не критические.<BR>
В случае критической ошибки считается, что команда не выполнена. <BR>
В случае не критической ошибки считается, что команда выполнена, либо будет выполнена позже.<BR><BR>
В случае ошибки при выполнении команды, ROOTPANEL.RU API возвращает параметры, перечисленные в таблице ниже.<BR>
<BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr valign=top class="<? print $font_row1?>"><td>status</td><td>Результат выполнения команды. В случае критической ошибки значение всегда равно ERROR. В случае не критической SUCCESS.</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>errorCode</td><td>Код ошибки</td></tr>
<tr valign=top class="<? print $font_row1?>"><td>errorMsg</td><td>Подробное описание ошибки</td></tr>
</table><BR>
В таблице ниже приведены возможные критические ошибки при работе с ROOTPANEL.RU API.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Код ошибки</B></td><td><B>Описание</b></td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>1</td><td>Ошибка подключения к БД</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>2</td><td>Ошибка сохранения данных в БД</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>3</td><td>Не указан логин пользователя</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>4</td><td>Пользователь не найден</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>5</td><td>Доступ к API отключен</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>6</td><td>Не указан пароль или ключ API</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>7</td><td>Указан неправильный пароль или ключ API</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>8</td><td>Неизвестная команда</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>9</td><td>Запрещено использовать пароль и ключ API в одном запросе</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>10</td><td>Тарифные планы отсутствуют</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>11</td><td>Не указан идентификатор тарифного плана</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>12</td><td>Тарифный план не найден</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>13</td><td>Не указано доменное имя</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>14</td><td>Тарифный план для указанного доменного имени уже заказан</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>15</td><td>Не указан срок заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>16</td><td>Указан недопустимый срок заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>17</td><td>Указана недопустимая дополнительная услуга</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>18</td><td>Не указан идентификатор заказа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>19</td><td>Заказ не найден</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>20</td><td>Для заказа есть неоплаченные счета</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>21</td><td>Заказ уже приостановлен</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>22</td><td>Заказ уже запущен</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>23</td><td>Заказ просрочен</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>24</td><td>Тип тарифного плана указан неверно</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>25</td><td>Операция не поддерживается для заказов данного типа</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>26</td><td>Заказы отсутствуют</td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>31</td><td>Недостаточно среств на внутреннем балансе</td></tr>
</table><BR>
В таблице ниже приведены возможные не критические ошибки при работе с ROOTPANEL.RU API.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Код ошибки</B></td><td><B>Описание</b></td></tr>
<tr valign=top class="<? print $font_row1?>"><td align=center>30</td><td>Заявка принята, но по техническим причинам будет обработана в ручном режиме.</td></tr>
</table><BR>
<a name=3.6></a><H1 class=pagetitle>3.6. Способы аутентификации</H1><BR>
В системе регистрации ROOTPANEL.RU API поддерживается два способа аутентификации: по логину и паролю, а также аутентификация по ключу API.<BR><BR>
<a name=3.6.1></a><H1 class=pagetitle>3.6.1. Аутентификация по паролю</H1><BR>
Аутентификация осуществляется с использованием полей запроса login и pass. Пользователь с указанным логином и паролем должен существовать в биллинговой системе для успешного прохождения аутентификации. Так же для него должен быть включен доступ к API.<BR><BR>
<a name=3.6.2></a><H1 class=pagetitle>3.6.2. Аутентификация по ключу API</H1><BR>
Аутентификация осуществляется с использованием полей запроса login и apikey. Пользователь с указанным логином и ключом API должен существовать в биллинговой системе для успешного прохождения аутентификации. Так же для него должен быть включен доступ к API.<BR><BR>
<a name=4></a><H1 class=pagetitle>4. Описание команд</H1><BR>
<a name=4.1></a><H1 class=pagetitle>4.1. Создание заказа</H1><BR>
Эта команда служит для создания нового заказа. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>createOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при создании заказа.<BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>vid</td><td>Тип тарифного плана. Допустимые значения - hosting, vds, dedicated. Если значение не задано, то используется hosting.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>tarifid</td><td>ID тарифного плана.<BR>Список доступных тарифных планов можно получить, выполнив команду, описанную в разделе <a href=#4.5 class=rootlink>4.5.</a></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>period</td><td>Период, на который производится создание заказа. Допустимые значения для данного поля по каждому тарифному плану можно получить, выполнив команду, описанную в разделе <a href=#4.5 class=rootlink>4.5.</a>. Значение необходимо указывать в месяцах. Пример: 1.</td></tr>.
<tr class="<? print $font_row1?>"><td valign=top>domain</td><td>Полное доменное имя, для которого создается заказ, например example.com. Допустимы алфавитно-цифровые символы и символ дефиса. Русские имена доменов указываются в кодировке utf-8. Поле не является обязательным, если значение параметра allowWithoutDomain для тарифного плана равняется 1.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>addons</td><td>ID дополнительной услуги, которую необходимо прикрепить к заказу. Несколько ID указываются через запятую.<BR>Список доступных дополнительных услуг для тарифного плана можно получить, выполнив команду, описанную в разделе <a href=#4.5 class=rootlink>4.5.</a> Поле не обязательное.</td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API. В дальнейшем используется для управления заказом.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>vid</td><td>Тип тарифного плана, который был использован для создания заказа.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>tarifid</td><td>ID тарифного плана в системе ROOTPANEL.RU API, который был использован для создания заказа.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>domain</td><td>Доменное имя, для которого был создан заказ.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>period</td><td>Период на который был создан заказ.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>addons</td><td>ID дополнительных услуг, которые были прикреплены к заказу.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>balance</td><td>Текущий баланс польователя.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>cost</td><td>Стоимость создания заказа.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>currency</td><td>Код валюты в которой возвращены стоимость и баланс. Идентична валюте пользователя в биллинговой системе.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>serverlogin</td><td>Дополнительные данные: логин заказа на сервере.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>serverpassword</td><td>Дополнительные данные: пароль заказа на сервере.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>remark</td><td>Дополнительные данные: примечание - может содержать различную дополнительную информацию по заказу.</td></tr>
</table><BR>
<a name=4.2></a><H1 class=pagetitle>4.2. Продление заказа</H1><BR>
Эта команда служит для продления заказа. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>renewOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при продлении заказа.<BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API, возвращаемый командой, описанной в разделе <a href=#4.1 class=rootlink>4.1.</a></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>period</td><td>Период, на который производится продление заказа. Допустимые значения для данного поля по каждому тарифному плану можно получить, выполнив команду, описанную в разделе <a href=#4.5 class=rootlink>4.5.</a>. Значение необходимо указывать в месяцах. Пример: 1.</td></tr>.
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>period</td><td>Период на который был продлен заказ.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>balance</td><td>Текущий баланс польователя.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>cost</td><td>Стоимость продления заказа.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>currency</td><td>Код валюты в которой возвращены стоимость и баланс. Идентична валюте пользователя в биллинговой системе.</td></tr>
</table><BR>
<a name=4.3></a><H1 class=pagetitle>4.3. Остановка заказа</H1><BR>
Эта команда служит для остановки заказа. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>suspendOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при остановке заказа.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API, возвращаемый командой, описанной в разделе <a href=#4.1 class=rootlink>4.1.</a></td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API.</td></tr>
</table><BR>
<a name=4.4></a><H1 class=pagetitle>4.4. Запуск остановленного заказа</H1><BR>
Эта команда служит для запуска остановленного заказа. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>unSuspendOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при запуске остановленного заказа.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API, возвращаемый командой, описанной в разделе <a href=#4.1 class=rootlink>4.1.</a></td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API.</td></tr>
</table><BR>
<a name=4.5></a><H1 class=pagetitle>4.5. Получение списка тарифных планов</H1><BR>
Эта команда служит для получения списка доступных тарифных планов. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>getTarifs</B>.<BR>
В таблице ниже перечислены поля, используемые при получении списка тарифных планов.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>vid</td><td>Тип тарифного плана. Допустимые значения - hosting, vds, dedicated. Если значение не задано, то используется hosting.</td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>tarifs</td><td>В данном поле возвращается массив полей. Каждое поле массива в свою очередь так же является массивом и содержит в себе следующие поля:<BR><BR><B>id</b> - ID тарифного плана<BR><B>vid</b> - тип тарифного плана<BR><B>name</B> - название тарифного плана<BR><B>costMonthly</b> - ежемесячная стоимость тарифного плана<BR><B>costSetup</b> - стоимость установки тарифного плана<BR><B>currency</b> - код валюты, в которой указана стоимость<BR><B>allowWithoutDomain</b> - если 1, то разрешено заказывать тарифный план без указания доменного имени<BR><B>months</b> - массив полей доступных сроков заказа:<BR> <B>months</b> - срок заказа в месяцах<BR> <B>discount</b> - скидка для данного срока заказа<BR> <B>allowForNewOrder</B> - если 1, то разрешено использовать срок заказа для новых заказов<BR> <B>allowForRenew</B> - если 1, то разрешено использовать срок заказа для продления заказов<BR><B>addons</b> - массив полей доступных дополнительных услуг:<BR> <B>id</b> - ID доп. услуги<BR> <B>name</b> - название доп. услуги<BR> <B>costMonthly</b> - ежемесячная стоимость доп. услуги<BR> <B>costSetup</b> - стоимость установки доп. услуги</td></tr>
</table><BR>
<a name=4.6></a><H1 class=pagetitle>4.6. Перезагрузка заказа</H1><BR>
Эта команда служит для перезагрузки заказа (сервера). Комманда поддерживается только для некоторых типов серверов. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>restartOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при перезагрузке заказа.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API, возвращаемый командой, описанной в разделе <a href=#4.1 class=rootlink>4.1.</a></td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API.</td></tr>
</table><BR>
<a name=4.7></a><H1 class=pagetitle>4.7. Переустановка заказа</H1><BR>
Эта команда служит для переустановки заказа (сервера). Комманда поддерживается только для некоторых типов серверов. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>reinstallOrder</B>.<BR>
В таблице ниже перечислены поля, используемые при переустановке заказа.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API, возвращаемый командой, описанной в разделе <a href=#4.1 class=rootlink>4.1.</a></td></tr>
</table><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orderid</td><td>ID заказа в системе ROOTPANEL.RU API.</td></tr>
</table><BR>
<a name=4.8></a><H1 class=pagetitle>4.8. Получение списка заказов</H1><BR>
Эта команда служит для получения списка заказов клиента. В качестве значения поля <B>command</b> для этой команды должно быть указано <B>getOrders</B>.<BR>
Для данной команды дополнительные поля отсутствуют.<BR><BR>
В случае успешного выполнения команды, ROOTPANEL.RU API вернет поля, перечисленные в таблице ниже.<BR><BR>
<table class="rpTable" width=<? print $width?>>
<tr align=center class="<? print $font_head?>"><td><B>Имя поля</B></td><td><B>Описание</b></td></tr>
<tr class="<? print $font_row1?>"><td valign=top>status</td><td>Если команда выполнена успешно, значение всегда будет SUCCESS.</td></tr>
<tr class="<? print $font_row1?>"><td valign=top>orders</td><td>В данном поле возвращается массив полей. Каждый массив содержит в себе следующие поля:<BR><BR><B>orderid</b> - ID заказа<BR><B>domain</B> - доменное имя<BR><B>domain_reg</B> - 0 - без регистрации домена, 1 - с регистрацией домена, 3 - с трансфером домена<BR><B>vid</b> - тип тарифного плана<BR><B>tarifid</b> - ID тарифного плана<BR><B>tarifname</B> - название тарифного плана<BR><B>orderdate</b> - дата оформления заказа<BR><B>startdate</b> - дата начала заказа<BR><B>todate</b> - дата до когда оплачен заказ<BR><B>leftdays</b> - кол-во дней до конца заказа<BR><B>status</b> - статус заказа (0 - не обработан, 1 - обработан, 2 - приостановлен, 3 - в обработке)</td></tr>
</table><BR>
<?
foot('utf-8');
mclose();
?>