Difference between revisions of "API: Server configuration"

Модуль

Функция

Входящие данные

Варианты ошибок

properties

Свойства сервера в момент выполнения запроса (дата и время, часовой пояс, hostname, язык и пр.).

getproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

getproperties (post или get)*  — константа, тип операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Информация была успешно получена';

error:1, mess:'Произошла ошибка при получении информации';

error:1000, mess:'У вас нет прав администратора'.   Если все сделано правильно, массив будет содержать следующие элементы:

[time], [locale],[hostname],[tz_date],[tz_time],[tz_time_m],[tz_time_s],[tz_time_h],[tz_timezone],[timezone_path],[timezone_name], [tz_sync]

properties

Смена времени.

settimeproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

settimeproperties (post или get)* — константа, тип операции;

date (post или get)* — новое время в формате 'Dec 14 00:05:00 EST 2016';

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Новая дата была успешно установлена';

error:1, mess:'Новое время было установлено';

error:1000, mess:'У вас нет прав администратора'.

properties

Смена часового пояса.

settzproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

settzproper (post или get)* — константа, тип операции;

tz (post или get)* — новый часовой пояс. Например, EST или WET;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Часовой пояс успешно изменен';

error:1, mess:'Произошла ошибка при смене часового пояса';

error:2, mess:'Указанный часовой пояс некорректный';

error:1000, mess:'У вас нет прав администратора'.

properties

Смена Hostname.

sethostnameproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

sethostnameproper (post или get)* — константа, тип операции;

hostname (post или get)* — новое имя хоста;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Новое имя хоста установлено';

error:1, mess:'Произошла ошибка при установке нового имени хоста';

error:2, mess:'Никорректное имя хоста';

error:1000, mess:'У вас нет прав администратора'.

properties

Смена root-пароля.

changerootpassprop

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

changerootpassprop (post или get)* — константа, имя операции;

rootps (post или get)* — новый пароль для root;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 

error:0, mess:'Пароль пользователя root успешно изменен';

error:1, mess:'Произошла ошибка при изменении пароля пользователя root';

error:2, mess:'Новый пароль для root слишком короткий, не менее 8 символов';

error:1000, mess:'У вас нет прав администратора'

properties

Смена brainysql-пароля.

changebrainysqlpassproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

changebrainysqlpassproper (post или get)* — константа, имя операции;

rootps (post или get)* — новый пароль для brainysql;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Пароль для brainysql успешно изменен;

error:1, mess:'Произошла ошибка при изменении пароля для brainysql';

error:2, mess:'Новый пароль для brainysql слишком короткий, не менее 8 символов';

error:1000, mess:'У вас нет прав администратора'.

properties

Смена языка.

changelangproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

changelangproper (post или get)* — константа, имя операции;

lang (post или get)* — установка язык ('ru' или 'en');

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Выбранный язык успешно установлен';

error:2, mess:'Указан некорректный параметр выбора языка';

error:1000, mess:'У вас нет прав администратора'.
 

properties

Смена данных для отправки почты панелью.

changetypemailproper

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

properties (post или get)* — константа, имя модуля;

changetypemailproper (post или get)* — константа, имя операции:

type (post или get)* — отправитель почты (smtp или phpmail);

language (post или get) — может принимать значение: en/ru (по умолчанию ru).   если 'type' = smtp, то запрашиваются следующие параметры:

    smtp_user (post или get)* — почтовый ящик от имени кого идет аутентификация;

    smtp_pass (post или get)* — пароль к этому пользователю;

    smtp_port (post или get)* — smtp-порт;

    smtp_host (post или get)* — имя узла сервиса smtp;

    encoding(post или get) — кодировка;

    smtp_from (post или get) — имя отправителя;

    smtp_headers — заголовки.     если 'type' = phpmail, то запрашиваются следующие параметры:

     smtp_headers (post или get) — заголовки.

error:0, mess:'Новые параметры успешно применены';

error:2, mess:'Указанный почтовый ящик некорректный';

error:3, mess:'Указанное имя хоста некорректно';

error:4, mess:'Не определен порт или он некорректный';

error:1000, mess:'У вас нет прав администратора'.