=====XML интерфейс управления (XML API)===== В системе реализирован XML интерфейс управления услугами и абонентами. Интерфейс находит по адресу WEB интерфейса. Оправка получение данных производится по протоколу HTTP POST/GET. Для получения данных в XML к запросам добавляется параметр ''&xml=1''. В системе есть возможность экспорта всех таблиц список в XML и CSV.\\ **Пример:**\\ Получить списка абонентов \\ **Запрос**\\ https://demo.abills.net.ua:9443/admin/index.cgi?index=11&EXPORT_CONTENT=USERS_LIST&xml=1&user=abills&passwd=demo ^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 | Производить сортировку в обратном порядке | **Ответ**\\ <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="-"/>
0 10.000000 0.00 Активно 0.000000
**Описание вывода:**\\ Начало списка |CAPTION |Заголовок списка | |ID |ИД списка | <COLUMN_1 NAME="Логин" SORT="DESC"/> <COLUMN_2 NAME="ФИО"/><COLUMN_3 NAME="Депозит"/> ... Описание и заголовки полей списка ... Секция данных |... | Маркер секции данных | |... | Маркер записи | | | Маркер поля | ===Информационные Сообщения=== Текст |MESSAGE | 9Идентификатор сообщения | |TYPE="info" | Тип сообщения \\ info - успешное віполнение операции \\ err - Ошибка при выполнении операции | |CAPTION | Заголовок сообщения | =====Примеры работы===== ====список доступных функций===== index.cgi?xml=1 2016-04-22 test 192.168.0.107 Активно 0 aV6x4cz9PC9jzVJ1 ===Информация об абоненте==== https://demo.abills.net.ua:9443/admin/index.cgi?qindex=15&UID=2396&xml=1&header=1&user=abills&passwd=demo |qindex=15 | Номер функции информации и изменения данных абонента | |UID=4884 | UID абонента | |xml=1 | флаг xml вывода | |header=1 | заголовок для бравзеров | Отображает список параметров абонента ====Добавление абонента==== **Пример** \\ https://demo.abills.net.ua:9443/admin/index.cgi?get_index=form_wizard&header=1&xml=1&add=1&LOGIN=test_user&CREATE_BILL=1&FIO=Test User Fio ====Управление абонентом==== Каждый из отображаемых параметров абонента можно изменить отправив 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. Управление состоянием абонента (активно, приостановлен, отключен и.т.д.) ====Поиск абонента==== формат запроса qindex=7&search_form=1&search=1&type=11&header=1&xml=1&[параметры поиска] **Пример** \\ поиск по номер контракта. контракт номер 3333 https://demo.abills.net.ua:9443/admin/index.cgi?qindex=7&search_form=1&search=1&type=11&header=1&xml=1&CONTRACT_ID=3333 Поиск по телефону https://demo.abills.net.ua:9443/admin/index.cgi?qindex=7&search_form=1&search=1&type=11&header=1&xml=1&PHONE=1234321 =====Пополнение депозита===== С помощь XML интерфейса можно пополнять счёт абонента \\ **Пример**\\ 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 | Проверка на существование оплаты с таким же идентификатором | ====Отображение информации по абоненту==== Отображение общей информации https://demo.abills.net.ua:9443/admin/index.cgi?qindex=11&header=1&UID=1091111056&xml=1&EXPORT_CONTENT=form_pi Отображение персональной информации https://demo.abills.net.ua:9443/admin/index.cgi?qindex=11&header=1&UID=1091111056&xml=1&EXPORT_CONTENT=user_pi ====Список оплат==== список оплат за определенный период https://demo.abills.net.ua:9443/admin/index.cgi?qindex=2&sort=1&EXPORT_CONTENT=PAYMENTS&header=1&xml=1&PAGE_ROWS=1000000&user=abills&passwd=demo&search=1&TO_DATE=2018-01-31&FROM_DATE=2018-01-01&METHOD=0 =====Начисления===== ===Список начислений=== список начислений за определенный период https://demo.abills.net.ua:9443/admin/index.cgi?qindex=3&EXPORT_CONTENT=FEES&header=1&xml=1&PAGE_ROWS=1000000&user=abills&passwd=demo&search=1&TO_DATE=2018-01-31&FROM_DATE=2018-01-01 ===Начисления=== С помощь XML интерфейса можно производить начисления \\ **Пример**\\ index.cgi?qindex=3&UID=4884&xml=1&header=1&SUM=100&take=1 |qindex=3 | Номер функции | |UID=4884 | ID абонента | |xml=1 | флаг xml вывода | |header=1 | заголовок для браузеров | |SUM=100 | Сума пополнения | |take=1 | Флаг начисления (снятия со счета) | Дополнительные параметры ^DESCRIBE | Описание платежа | ^INNER_DESCRIBE | Коментарий для администратора | ^ER | Курс обмена. Указывается номер курса | ^METHOD | Тип снятия | ====Изменении параметров услуг==== Изменении дополнительных данных абонента из модулей расширения (Dv, Voip, IPTV). Данными для изменения могут быть * IP Адрес * Тарифный план * Статус сервиса \\ **Информация о сервисе Internet** index.cgi?get_index=dv_user&xml=1&header=1&UID=4884 |get_index=dv_user | Информация по услуге Internet | |UID=4884 | ID абонента | |xml=1 | флаг xml вывода | |header=1 | заголовок для браузеров | \\ **Изменении Тарифного плана и статуса для сервиса сервисе Internet** \\ index.cgi?get_index=dv_user&xml=1&header=1&UID=4884&TP_ID=21&STATUS=5&change=1 |get_index=dv_user || |UID=4884 | ID абонента | |xml=1 | флаг xml вывода | |header=1 | заголовок для браузеров | |TP_ID=21 | Номер нового тарифного палана | |STATUS=4 | Установить статус услуги 5 (слишком маленький депозит) \\ \\ Статусы: \\ 0 Активно \\ 1 Отключено \\ 2 Не активизирован \\ 3 Приостановление \\ 4 Отключено: Неуплата \\ 5 Cлишком маленький депозит | |change=1 | Применить изменения | **Установка изменения тарифного плана по расписанию**\\ UID=4889&Shedule=status&get_index=dv_form_shedule&xml=1&header=1&Shadule=status&DATE=2012-11-01&ACTION=3&add=1 |get_index=dv_form_shedule | управление расписанием | |Shedule=status | Изменении статуса учётной записи | |DATE | Зада когда надо изменить в формате (YYYY-MM-DD) | |ACTION | Номер статуса для изменения | |add | Применить действия | =====Документы===== ====Список счетов==== Список счетов https://demo.abills.net.ua:9443/admin/index.cgi?get_index=docs_invoices_list&full=1&sort=1&EXPORT_CONTENT=DOCS_INVOICES_LIST&header=1&xml=1&PAGE_ROWS=1000000&user=abills&passwd=demo ====Управление точками подключения==== **Добавление домов** \\ (add=1) index.cgi?get_index=form_streets&BUILDS=5261&NUMBER=69&STREET_ID=5261&add=1&xml=1&header=1 Параметры ^BUILDS | Номер улицы для идентификации прикреплённых домов | ^STREET_ID | Номер улицы номер улицы для дома. Если дом переносится на другую улицу этот номер будет отличатся от BUILDS. Если не переносится номера идентичны | ^ENTRANCES | Подездов | ^FLORS | Этажей | ^FLATS | Квартир | ^CONTRACT_ID | Номер контракта | ^COMMENTS | Коментарий | ^COORDX | координаты для google map | ^COORDY | координаты для google map | **Изменение параметров точки подключения (дома) ** \\ (change=1) index.cgi?get_index=form_streets&BUILDS=5261&LOCATION_ID=3618&COMMENTS=test&change=1&xml=1&header=1 ^ ID | уникальный номер дома в системе | ====Управление серверами доступа==== **Добавление сервера доступа** \\ index.cgi?get_index=form_nas&add=1&header=1&NAS_NAME=test_geo2&IP=22.11.11.11 ^IP | IP адрес | ^NAS_NAME | Название | ^TYPE | Тип | ^NAS_ALIVE | Время подтверждения активности | ^NAS_DISABLE | Статус \\ 0 - Активен \\ 1 - Выключен \\ 2 - В ремонте | ^NAS_MNG_IP_PORT | IP/Port управления | ^NAS_MNG_USER | Пользователь для управления | ^NAS_MNG_PASSWORD | Пароль управления | ^NAS_DESCRIBE | Описание устройства | ^NAS_ID | ID устройства | ^NAS_IDENTIFIER | Дополнительный идентификатор | ^MAC | MAC устройства | ^GID | Группа | ^LOCATION_ID | Привязка к адресу | =====JSON интерфейс===== В системе реализирован JSON интерфейс управления услугами и абонентами. Интерфейс находит по адресу WEB интерфейса. Оправка получение данных производится по протоколу HTTP POST/GET. Для получения данных в JSON формате к запросам добавляется параметр &json=1. * [[abills:docs:manual:json_api|JSON API]]
0 10.000000...