1 <?xml version='1.0' encoding='UTF-8'?>
2 <chapter xmlns="http://docbook.org/ns/docbook">
3 <title>Авторизация в системе</title>
4 <para>В этом разделе собраны функции, не относящиеся к манипулированию сущностями системы. А именно: отвечающие за авторизацию в системе, получение информации о системе и т.д.</para>
5 <refentry id="stargazer.login">
7 <refentrytitle>stargazer.login</refentrytitle>
10 <refname>stargazer.login</refname>
11 <refpurpose>Авторизация администратора в системе</refpurpose>
16 <funcdef><function>stargazer.login</function></funcdef>
17 <paramdef>string <parameter>login</parameter></paramdef>
18 <paramdef>string <parameter>password</parameter></paramdef>
23 <title>Description</title>
24 <para>Метод <function>stargazer.login</function> авторизует администратора в системе. Если логин и пароль корректные - создается cookie и открывается сессия. В дальнейшем все вызовы API получают этот cookie. Если указаный администратор в системе не найден или его пароль не совпадает - сессия не открывается и cookie не создается.</para>
27 <term>string <parameter>login</parameter></term>
29 <para>Логин администратора</para>
33 <term>string <parameter>password</parameter></term>
35 <para>Пароль администратора</para>
40 <title>Return Value</title>
45 <term>bool <structfield>result</structfield></term>
47 <para>Результат операции. true - авторизация прошла успешно, false - авторизация завершилась неудачей.</para>
51 <term>string <structfield>cookie</structfield></term>
53 <para>Авторизационный cookie. В случе успешной авторизации представляет собой строку из 64 символов, передаваемую во все вызовы API. В случае неудачи - пустая строка.</para>
61 <title>See also</title>
62 <para><link linkend="stargazer.logout">stargazer.logout</link></para>
65 <refentry id="stargazer.logout">
67 <refentrytitle>stargazer.logout</refentrytitle>
70 <refname>stargazer.logout</refname>
71 <refpurpose>Завершение сессии администратора в системе</refpurpose>
76 <funcdef><function>stargazer.logout</function></funcdef>
77 <paramdef>string <parameter>cookie</parameter></paramdef>
82 <title>Description</title>
83 <para>Метод <function>stargazer.logout</function> завершает сеанс работы авторизатора в системе.</para>
86 <term>string <parameter>cookie</parameter></term>
88 <para>Авторизационный cookie</para>
93 <title>Return Value</title>
94 <para>Возвращает true в случае успеха и false в случае неудачи.</para>
98 <title>See also</title>
99 <para><link linkend="stargazer.login">stargazer.login</link></para>
102 <refentry id="stargazer.info">
104 <refentrytitle>stargazer.info</refentrytitle>
107 <refname>stargazer.info</refname>
108 <refpurpose>Информация о сервере</refpurpose>
113 <funcdef><function>stargazer.info</function></funcdef>
118 <title>Description</title>
119 <para>Метод <function>stargazer.info</function> возвращает информацию о сервере Stargazer. Не требует авторизации.</para>
121 <title>Return Value</title>
123 Возвращает структуру:
126 <term>string <structfield>version</structfield></term>
128 <para>Версия Stargazer</para>
132 <term>int <structfield>tariff_num</structfield></term>
134 <para>Количество тарифов в системе</para>
138 <term>int <structfield>tariff</structfield></term>
140 <para>Версия тарифов (обычно 2)</para>
144 <term>int <structfield>users_num</structfield></term>
146 <para>Количество зарегистрированных пользователей в системе</para>
150 <term>string <structfield>uname</structfield></term>
152 <para>Строка uname</para>
156 <term>int <structfield>dir_num</structfield></term>
158 <para>Количество тарифицируемых направлений</para>
162 <term>int <structfield>day_fee</structfield></term>
164 <para>День снятия абонплаты</para>
168 <term>array of strings <structfield>dir_names</structfield></term>
170 <para>Названия направлений</para>