Различия

Здесь показаны различия между двумя версиями данной страницы.

--- abills:docs:manual:json_api [2015/12/05 17:50]
127.0.0.1 внешнее изменение
+++ abills:docs:manual:json_api [2017/11/24 15:54] (текущий)
bohdan [Абоненты с подключённой интернет услугой (IPoE)]
@@ Строка 10: / Строка 10: @@
 **Пример**
-https://demo.abills.net.ua:9443/admin/index.cgi?get_index=dv_tp&EXPORT_CONTENT=DV_TARIF_PLANS&header=1&json=1&API_KEY=1523615231263123
+https://demo.abills.net.ua:9443/admin/index.cgi?get_index=internet_tp&EXPORT_CONTENT=INTERNET_TARIF_PLANS&header=1&json=1&API_KEY=1523615231263123
@@ Строка 24: / Строка 24: @@
+====Поиск абонентов====
+Поиск абонентов по унивесрсальному ключу
+^qindex=7 ||
+^search=1 | Включить поиск|
+^&type=10 | Тип поиска|
+^&header=1 | показать заголовок |
+^LOGIN=testuser | Параметр поиска. Поиск осуществляется по всем полям универсального поиска |
+^EXPORT_CONTENT=USERS_LIST | Експортировать то только контент поиска |
+^&SKIP_FULL_INFO=1 | Отображать информацию в формате таблицы |
+Запрос:
+https://demo.abills.net.ua:9443/admin/index.cgi?qindex=7&search=1&type=10&header=1&json=1&LOGIN=testuser&EXPORT_CONTENT=USERS_LIST&SKIP_FULL_INFO=1&API_KEY=1523615231263123
 ====Информация об абоненте====
@@ Строка 31: / Строка 48: @@
 Запрос:
-https://demo.abills.net.ua:9443/admin/index.cgi?qindex=15&UID=109103&SUMMARY_SHOW=1&EXPORT=1
+https://demo.abills.net.ua:9443/admin/index.cgi?qindex=15&UID=109103&SUMMARY_SHOW=1&EXPORT=1&API_KEY=1523615231263123
 ^qindex=15 ||
@@ Строка 139: / Строка 156: @@
 |CREDIT|Кредит|
 |CREDIT_TRESSHOLD|Несъёмный минимум|
-|DAY_FEE checked|Дневная а/п|
+|DAY_FEE |Дневная а/п|
 |DAY_TIME_LIMIT|Лимит времени День|
 |DAY_TRAF_LIMIT|Лимит трафика День|
@@ Строка 146: / Строка 163: @@
 |FINE|Пеня|
 |FIXED_FEES_DAY|Фиксированная дата  абон. платы|
-|ID checked|Номер|
+|ID |Номер|
 |IN_PRICE|Цена Получено|
 |IN_SPEED|Скорость Получено|
@@ Строка 155: / Строка 172: @@
 |MIN_SESSION_COST|Минимальная цена сессии|
 |MIN_USE|Минимальная денежная наработка|
-|MONTH_FEE checked|Абонплата за месяц|
+|MONTH_FEE |Абонплата за месяц|
 |MONTH_TIME_LIMIT|Лимит времени Месяц|
 |MONTH_TRAF_LIMIT|Лимит трафика Месяц|
-|NAME checked|Название|
+|NAME |Название|
 |NEG_DEPOSIT_FILTER_ID|Фильтр негативного Депозита|
 |NEG_DEPOSIT_IPPOOL|Пул адресов негативного депозита|
@@ Строка 165: / Строка 182: @@
 |OUT_PRICE|Цена Отправлено|
 |OUT_SPEED|Скорость Отправлено|
-|PAYMENT_TYPE checked|Вид оплаты|
+|PAYMENT_TYPE |Вид оплаты|
 |PERIOD_ALIGNMENT|Выравнивание месяца|
 |POSTPAID_DAY_FEE|Дневная а/п Послеоплата|
@@ Строка 174: / Строка 191: @@
 |REDUCTION_FEE|Скидка|
 |SMALL_DEPOSIT_ACTION|Действие при недостаточном депозите|
-|TIME_TARIFS checked|Часовой тариф|
+|TIME_TARIFS |Часовой тариф|
 |TOTAL_TIME_LIMIT|Лимит времени Всего|
 |TOTAL_TRAF_LIMIT|Лимит трафика Всего|
 |TP_GID|Группа|
-|TRAF_TARIFS checked|Тарифы трафика|
+|TRAF_TARIFS |Тарифы трафика|
 |TRAFFIC_TRANSFER_PERIOD|Период перехода трафика|
 |UPLIMIT|Предупреждение|
@@ Строка 281: / Строка 298: @@
 </code>
+====Дома улицы====
+|BUILDS=xxx  | ID  улицы |
+Запрос:
+https://demo.abills.net.ua:9443/admin/index.cgi?get_index=form_streets&BUILDS=102&EXPORT_CONTENT=BUILDS_LIST&header=1&json=1&PAGE_ROWS=1000000&API_KEY=1523615231263123
+Ответ:
+<code>
+{ "CAPTION" : "Дома",
+ "ID" : "BUILDS_LIST",
+"TITLE" : [
+"Номер","Этажи","Подъезды","Квартиры","Улицы"," Пользователи","Плотность подключения","Добавлено","Карта сети X","-","-" ],
+"DATA_1" : [
+  {"number" : "2", "flors" : "0", "entrances" : "0", "flats" : "0", "street_name" : "Гоголя", "users_count" : "2", "users_connections" : "", "added" : "2015-10-17", "coordx" : ""},
+ {"number" : "4", "flors" : "0", "entrances" : "0", "flats" : "0", "street_name" : "Гоголя", "users_count" : "0", "users_connections" : "", "added" : "2015-10-17", "coordx" : ""}
+]
+}
+</code>
+Список полей
+^ ENTRANCES | Подъезды |
+^ FLATS | Квартиры |
+^ FLORS | Этажи |
+^ LOCATION_ID | LOCATION ID точка включения |
+^ NUMBER | Номер |
+^ STREET_NAME | Улицы |
+^ USERS_CONNECTIONS | Плотность подключения |
+^ USERS_COUNT | количество абонентов |
 ====Информационные поля====
@@ Строка 327: / Строка 377: @@
-====Абоненты с подключённой интернет услугой====
+====Абоненты с подключённой интернет услугой (PPPoE/PPTP)====
 Запрос:
-https://demo.abills.net.ua:9443/admin/index.cgi?get_index=dv_users_list&EXPORT_CONTENT=INTERNET_USERS_LIST&header=1&json=1&PAGE_ROWS=1000000
+https://demo.abills.net.ua:9443/admin/index.cgi?get_index=dv_users_list&EXPORT_CONTENT=INTERNET_USERS_LIST&header=1&json=1&PAGE_ROWS=1000000&API_KEY=1523615231263123
@@ Строка 348: / Строка 398: @@
 }
+</code>
+**Дополнительные поля**
+^ACTIVATE |Активация  |
+^ADDRESS_BUILD |Дом  |
+^ADDRESS_FLAT |Квартира  |
+^ADDRESS_FULL |Полный Адрес  |
+^ADDRESS_STREET |Улица  |
+^BILL_ID |Денежные счета  |
+^CID |Caller ID. Может быть MAC, телефон, IP  для вторичной авторизации абонента   |
+^CITY |Город  |
+^COMMENTS |Комментарии  |
+^COMPANY_ID |Компании ID  |
+^CONTRACT_ID |Номер контракта  |
+^CREDIT  |Кредит  |
+^CREDIT_DATE |Кредит Дата  |
+^DELETED |Удалено  |
+^DEPOSIT  |Депозит  |
+^DISTRICT_NAME |Районы  |
+^DOMAIN_ID |DOMAIN ID  |
+^DV_EXPIRE |Internet Окончание  |
+^DV_LOGIN |Услуга Логин  |
+^DV_PASSWORD |Услуга Пароль  |
+^DV_STATUS  |Internet Статус  |
+^DV_STATUS_DATE |Статус Дата  |
+^EMAIL |E-Mail  |
+^EXPIRE |Окончание  |
+^EXT_DEPOSIT |Дополнительный Депозит  |
+^FILTER_ID |Filter ID  |
+^FIO  |ФИО  |
+^GID |Группа  |
+^GROUP_NAME |Группа Название  |
+^IP |IP  |
+^LAST_PAYMENT |Последняя оплата  |
+^LOGIN  |Логин  |
+^LOGIN_STATUS |Логин Статус  |
+^MONTH_TRAFFIC_IN  |Месяц Получено  |
+^MONTH_TRAFFIC_OUT  |Месяц Отправлено  |
+^NETMASK |NETMASK  |
+^ONLINE |Online  |
+^PASPORT_DATE |Паспорт Дата  |
+^PASPORT_GRANT |Паспорт Выдано  |
+^PASPORT_NUM |Паспорт Номер  |
+^PHONE |Телефон  |
+^PORT |Порт  |
+^REDUCTION |Скидка  |
+^REGISTRATION |Регистрация  |
+^SPEED |Скорость  |
+^TP_NAME |Тарифный план  |
+^UID |UID  |
+^ZIP |Индекс  |
+====Информация про Internet услугу ====
+  https://demo.abills.net.ua:9443/admin/index.cgi?qindex=130&UID=112&sort=1&EXPORT_CONTENT=internet_user&header=1&json=1&API_KEY=1523615231263123
+<code>
+{
+	"internet_user": {
+		"STATUS": "5",
+		"STATUS_COLOR": "#009688",
+		"STATUS_COLOR_GR_S": "#00b4a3",
+		"STATUS_COLOR_GR_F": "#00877a",
+		"ID": "88",
+		"UID": "112",
+		"TP_NUM": "1002",
+		"TP_NAME": "4G Стандарт",
+		"TP_ID": "25",
+		"CHANGE_TP_BUTTON": "Изменить",
+		"IP": "0.0.0.0",
+		"NETMASK": "255.255.255.255",
+		"SERVICE_ACTIVATE": "0000-00-00",
+		"SERVICE_EXPIRE": "0000-00-00",
+		"FILTER_ID": "RAD:mpd-table-static+=100=%IP%",
+		"TURBO_MODE_FORM": ",",
+		"ACTION": "change",
+		"LNG_ACTION": "Изменить",
+		"DEL_BUTTON": "Удалить"
+	}
+}
 </code>
+====Абоненты с подключённой интернет услугой (IPoE)====
+Запрос:
+https://demo.abills.net.ua:9443/admin/index.cgi?get_index=dhcphosts_hosts&EXPORT_CONTENT=DHCP_HOSTS&header=1&json=1&PAGE_ROWS=1000000&API_KEY=1523615231263123
+Ответ:
+<code>
+ "ID" : "DHCP_HOSTS",
+"TITLE" : [
+"#","Логин","IP","Hostname","netwirk_name","MAC","DHCP Статус","-","-" ],
+"DATA_1" : [
+  {"id" : "4", "login" : "", "ip" : "192.168.11.23", "hostname" : "test_", "netwirk_name" : "DHCP_NET_5", "mac" : "00:00:00:00:0A:11", "status" : "Активно"},
+ {"id" : "12", "login" : "109059", "ip" : "192.168.0.47", "hostname" : "Host_109059_1", "netwirk_name" : "DHCP_NET", "mac" : "33:33:33:33:33:11", "status" : "Активно"},
+ {"id" : "13", "login" : "109059", "ip" : "192.168.0.47", "hostname" : "Host_109059_223", "netwirk_name" : "DHCP_NET", "mac" : "33:33:33:33:33:12", "status" : "Активно"},
+ {"id" : "67", "login" : "Fedorov", "ip" : "10.11.1.12", "hostname" : "Fedorov1", "netwirk_name" : "DHCP_NET1", "mac" : "00:0c:0c:99:Ac:23", "status" : "Активно"}
+]
+}
+</code>
+**Дополнительные поля**
+^ACTIVATE | Активация |
+^ADDRESS_BUILD | Дом |
+^ADDRESS_FLAT | Квартира |
+^ADDRESS_FULL | Полный Адрес |
+^ADDRESS_STREET | Улица |
+^BILL_ID | Денежные счета |
+^BOOT_FILE | Boot file |
+^CITY | Город |
+^COMMENTS | Комментарии |
+^COMPANY_ID | Компании ID |
+^CONTRACT_ID | Номер контракта |
+^CREDIT | Кредит |
+^CREDIT_DATE | Кредит Дата |
+^DELETED | Удалено |
+^DEPOSIT | Депозит |
+^DISTRICT_NAME | Районы |
+^DOMAIN_ID | DOMAIN ID |
+^EMAIL | E-Mail |
+^EXPIRE | Окончание |
+^EXT_DEPOSIT | Дополнительный Депозит |
+^FIO | ФИО |
+^GID | Группа |
+^GROUP_NAME | Группа Название |
+^HOSTNAME | Hostname |
+^ID | # |
+^IP | IP |
+^IPN_ACTIVATE | IPN Activate |
+^LAST_PAYMENT | Последняя оплата |
+^LOGIN | Логин |
+^LOGIN_STATUS | Логин Статус |
+^MAC | MAC |
+^MONTH_TRAFFIC_IN  |Месяц Получено  |
+^MONTH_TRAFFIC_OUT  |Месяц Отправлено  |
+^NAS_ID | NAS ID |
+^NAS_IP | NAS IP |
+^NAS_NAME | Сервер доступа |
+^NETWORK_NAME | Сеть |
+^NEXT_SERVER | Next Server |
+^OPTION_82 | Option 82 |
+^PASPORT_DATE | Паспорт Дата |
+^PASPORT_GRANT | Паспорт Выдано |
+^PASPORT_NUM | Паспорт Номер |
+^PHONE | Телефон |
+^PORTS | Порт |
+^REDUCTION | Скидка |
+^REGISTRATION | Регистрация |
+^SERVER_VID | Server VLAN |
+^STATUS | DHCP Статус |
+^TP_NAME |Тарифный план  |
+^UID | UID |
+^VID | Пользователь VLAN |
+^ZIP | Индекс |
+также можно подставлять информационные поля \\
+функция работает на версии abills 0.77 и ниже
 ====API information=====
@@ Строка 376: / Строка 585: @@
+=====HELP DESK=====
+  *  [[abills:docs:manual:json_api_msgs|Help DESK]]