В системе реализован XML интерфейс управления услугами и абонентами. Интерфейс находит по адресу WEB интерфейса. Оправка, получение данных производится по протоколу HTTP POST/GET. Для получения данных в XML к запросам добавляется параметр &xml=1
. В системе есть возможность экспорта всех таблиц список в XML и CSV.
Пример:
Получить список абонентов
Запрос
index=11 | Номер функции. В системе существует динамическая нумерация функций в зависимости от настроек системы и настроек параметров доступа. По этому возможны ситуации, когда номера функций не будут отображать те же данные под разными аккаунтами. Для получения правильных номеров функции можно использовать параметр get_index=[название функции] https://your.host:9443/admin/index.cgi?get_index=form_users&xml=1 |
---|---|
EXPORT_CONTENT=USERS_LIST | Экспортировать только данные таблицы USERS_LIST (список пользователей) |
xml=1 | Отобразить исходные данные в формате XML |
Дополнительные параметры
&show_columns=LOGIN,FIO,CONTRACT_ID,CONTRACT_DATE,BILL_ID | Отображать только заданные колонки. Задаются через запятую без пробелов |
---|---|
&PAGE_ROWS=1000000 | Количество результатов вывода. По умолчанию 25 |
&sort=1 | Номер поля для сортировки |
&desc=DESC | Производить сортировку в обратном порядке |
Ответ
Code Block | ||||
---|---|---|---|---|
| ||||
<TABLE CAPTION="Пользователи - Все" ID="USERS_LIST"> <TITLE columns="8"> <COLUMN_1 NAME="Логин" SORT="DESC"/> <COLUMN_2 NAME="ФИО"/><COLUMN_3 NAME="Депозит"/> <COLUMN_4 NAME="Кредит"/><COLUMN_5 NAME="Статус"/> <COLUMN_6 NAME="Дополнительный Депозит"/> <COLUMN_7 NAME="-"/> <COLUMN_8 NAME="-"/> </TITLE> <DATA><ROW> <TD>0</TD> <TD/> <TD>10.000000</TD> <TD>0.00</TD> <TD>Активно</TD> <TD>0.000000</TD> <TD><BUTTON VALUE="index=2&UID=108446">Оплаты</BUTTON></TD> <TD><BUTTON VALUE="index=3&UID=108446">Снятие денег</BUTTON></TD> </ROW> </TABLE> |
Описание вывода:
Code Block | ||
---|---|---|
| ||
<TABLE CAPTION="Пользователи - Все" ID="USERS_LIST"> |
Начало списка:
CAPTION | Заголовок списка |
---|---|
ID | ИД списка |
Code Block | ||
---|---|---|
| ||
<TITLE columns="8"> <COLUMN_1 NAME="Логин" SORT="DESC"/> <COLUMN_2 NAME="ФИО"/><COLUMN_3 NAME="Депозит"/> ... </TITLE> |
Описание и заголовки полей списка:
Code Block | ||
---|---|---|
| ||
<DATA> <ROW> <TD>0</TD> <TD/> <TD>10.000000</TD> ... </ROW> </DATA> |
Секция данных:
<DATA>…</DATA> | Маркер секции данных |
---|---|
<ROW>…</ROW> | Маркер записи |
<TD>…</TD> | Маркер поля |
Информационные Сообщения
Code Block | ||
---|---|---|
| ||
<MESSAGE TYPE="info" CAPTION="Fees">Текст</MESSAGE> |
MESSAGE | Идентификатор сообщения |
---|---|
TYPE=«info» | Тип сообщения info - успешное выполнение операции err - Ошибка при выполнении операции |
CAPTION | Заголовок сообщения |
Примеры работы
Список доступных функций
Code Block | ||
---|---|---|
| ||
index.cgi?xml=1 |
Code Block | ||||
---|---|---|---|---|
| ||||
<INFO>
<TITLE_TEXT/>
<BODY>
<INFO>
<TIME>15:51:32</TIME>
<DATE>2016-04-22</DATE>
<LOGIN>test</LOGIN>
<IP>192.168.0.107</IP>
<STATE>Активно</STATE>
<STATE_CODE>0</STATE_CODE>
<MENU>
<SID>aV6x4cz9PC9jzVJ1</SID>
<MENU NAME="iptv_user_info" ID="64" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Телевидение" TYPE="MAIN"/>
<MENU NAME="iptv_user_chg_tp" ID="65" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Тарифный план"
TYPE="SUB" PARENT="64"/>
<MENU NAME="ashield_user" ID="63" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Антивирус Dr.Web"
TYPE="MAIN"/>
<MENU NAME="cards_user_payment" ID="60" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Интернет карточки"
TYPE="MAIN"/>
<MENU NAME="sharing_user_info" ID="58" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Sharing" TYPE="MAIN"/>
<MENU NAME="sharing_user_stats" ID="59" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Статистика" TYPE="SUB"
PARENT="58"/>
<MENU NAME="ipn_user_activate" ID="55" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="IP Net" TYPE="MAIN"/>
<MENU NAME="ipn_getnet" ID="57" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Тарифы трафика" TYPE="SUB"
PARENT="55"/>
<MENU NAME="ipn_sessions2" ID="56" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Статистика" TYPE="SUB"
PARENT="55"/>
<MENU NAME="msgs_user" ID="54" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Техническая Поддержка"
TYPE="MAIN"/>
<MENU NAME="mail_users_list" ID="53" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="E-MAIL" TYPE="MAIN"/>
<MENU NAME="docs_invoices_list" ID="52" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="Документы"
TYPE="MAIN"/>
<MENU NAME="voip_user_info" ID="49" EX_ARGS="&sid=aV6x4cz9PC9jzVJ1" DESCRIBE="VoIP" TYPE="MAIN"/> |
Информация об абоненте
qindex=15 | Номер функции информации и изменения данных абонента |
---|---|
UID=4884 | UID абонента |
xml=1 | флаг xml вывода |
header=1 | заголовок для браузеров |
Отображает список параметров абонента.
Добавление абонента
Пример
Управление абонентом
Каждый из отображаемых параметров абонента можно изменить отправив
Code Block | ||
---|---|---|
| ||
change=1&НАЗВАНИЕ_ПАРАМЕТРА=Значение параметра |
Пример
Изменить кредит на значение 35
https://demo.abills.net.ua:9443/admin/index.cgi?qindex=15&UID=4884&xml=1&header=1&change=1&CREDIT=35
1. Управление состоянием абонента (активно, приостановлен, отключен и.т.д.)
Поиск абонента
Формат запроса
Code Block | ||
---|---|---|
| ||
qindex=7&search_form=1&search=1&type=11&header=1&xml=1&[параметры поиска] |
Пример
Поиск по номеру контракта. контракт номер 3333
Поиск по телефону
Пополнение депозита
С помощь XML интерфейса можно пополнять счёт абонента
Пример
Code Block | ||
---|---|---|
| ||
https://demo.abills.net.ua:9443/admin/index.cgi?qindex=2&UID=4884&xml=1&header=1&SUM=100&add=1 |
qindex=2 | Номер функции |
---|---|
UID=4884 | ID абонента |
xml=1 | флаг xml вывода |
header=1 | заголовок для браузеров |
SUM=100 | Сумма пополнения |
add=1 | Флаг добавления денег |
Дополнительные параметры:
DESCRIBE | Описание платежа |
---|---|
INNER_DESCRIBE | Комментарий для администратора |
ER | Курс обмена. Указывается номер курса |
METHOD | Метод оплаты |
EXT_ID | Внешний идентификатор |
BILL_ID | Денежный счёт. Если не указан, используется основной |
DATE=YYYY-MM-DD | Дата платежа |
CHECK_EXT_ID=xxx | Проверка на существование оплаты с таким же идентификатором |