Розбіжності

Тут показані розбіжності між вибраною ревізією та поточною версією сторінки.

--- remoteapi [2020/05/15 08:58]
+++ remoteapi [2023/06/15 17:51]
nightfly
@@ Рядок 1: / Рядок 1: @@
+====== API віддаленого виклику процедур ======
+У Ubilling починаючи з релізу 0.3.1 підтримується виклик зовнішніми програмами певних внутрішніх процедур білінгу. \\
+Для цього потрібна опція
+<code ini>
+REMOTEAPI_ENABLED=1
+</code>
+в конфігураційному файлі  [[alteriniconf|alter.ini]]. Для авторизації використається серійний номер Ubilling.\\
+Формат викликів за допомогою HTTP GET запитів:
+<code>
+  http://billing.isp/?module=remoteapi&key=[ubserial]&action=[action][&param=[parameter]]
+</code>
+На даний момент підтримуються наступні action:\\
+  * **reset + param [login]** - ресет користувача, логін – обов'язковий параметр.
+  * **handlersrebuild** - перебудова всіх мережних хендлерів та перезапуск dhcpd для відповідних підмереж
+  * **vserviceschargefee + param [nofrozen]** - зняття АП віртуальних сервісів. Необов'язковий параметр nofrozen - не знімати АП з відморозків.
+     * //**&period**// - дозволяє вказати період зняття оплати днями для фільтрації сервісів за цією ознакою. Тільки сервіси, що задовольняють умовам фільтра, будуть оброблені, що дозволяє, наприклад, зробити роздільну обробку сервісів з помісячним і поденним зняттям АП (так - таким чином можна робити кілька викликів vserviceschargefee з crontab): //&period=30// або //&period= 1//. \\ Також можна групувати періоди зняття оплат в одному виклику, розділяючи їх **підкресленням**: //&period=30_7_15//.
+  * **discountprocessing** - обробка знижок
+  * **backupdb** - резервування БД
+  * **autocleandb** - зачистка БД від старих логів та детальної статистики
+  * **swpoll** - опитування всіх пристроїв з довідника "Комутатори" за допомогою SNMP з метою заповнення кешу сирих даних
+  * **swping** - опитування всіх пристроїв з довідника "Комутатори" "на живість" за допомогою ICMP ping
+  * **fullhostscan + param [traffdiff] + nn** - опитування всіх клієнтів з підмереж вказаних у довіднику "Мережі та сервіси" за допомогою nmap а також за вказівкою параметра traffdiff намагається аналізувати активність зі змін вихідного трафіку. Також параметр nn (наприклад &nn=1) відключає використання nmap, що радикально підвищує швидкодію виклику fullhostscan (рекомендовано).
+  * **rebuilduserdatacache** - перебудовується кеш даних користувача в exports: cache_address, cache ips, cache mac
+  * **autofreeze + param [nocredit]** -  запускає процедуру автозаморозки користувачів з балансом нижче alter.ini:AUTOFREEZE_CASH_LIMIT
+  * **autofreezemonth + param [nocredit]** - запускає процедуру автозаморозки користувачів з балансом нижче або рівним alter.ini:(AUTOFREEZE_CASH_LIMIT*вартість тарифу). Опційний параметр nocredit символізує своїм видом, виключення з автозаморозки користувачів, які скористалися функцією кредитування в кабінеті користувача в поточному місяці.
+  * **watchdog** - нацьковує собаку-спостерігаку на виконання її завдань
+  * **senddog** - [[senddog|собака-посилака]] пробігається по всіх чергах для відправлення та здійснює відправлення всіх повідомлень.
+  * **senddog + [param chkmsgstatuses]** - необхідно лише за включеної історії СМС повідомлень. Зобов'язує [[senddog|собаку-посилаку]] спробувати отримати статуси раніше відправлених СМС.
+   * **ukvfeeprocessing** - зняття АП користувачів [[ukv|УКВ]]
+  * **switchescoverage  + param [1000x800]** - повертає карту покриття комутаторами, з розмірами вказаними у param у форматі XxY
+  * **rebuildglscache** - примусово перебудовується кеш глобального пошуку.
+  * **uhwbrutecleanup** - очищує реєстр спроб перебору паролів UHW
+  * **cudiscounts** -  запускає механізм обробки [[cumulativediscounts|накопичувальних знижок]].
+  * **crimeandpunishment** - запускає механізм [[crimeandpunishment|обробки злочинів та кари]].
+  * **oltpoll** - запускає опит усіх OLT пристроїв.
+  * **reminder + [param force]**  - запускає SMS нагадування. Черга SMS буде оброблена під час наступного запуску senddog. Необов'язковий param=force здійснює примусову посилку всім користувачам, крім заморожених, трансліт примусовий.
+  * **friendshipdaily** - здійснює внесення відсотків за всіма дружніми платежами, за попередню добу.
+  * **freezemonth + [param debug2ublog]** - здійснює списання коштів у заморожених користувачів рівним alter.ini:FREEZEMONTH_COST. Необов'язковий параметр //debug2ublog// включає дебаг-режим та запис того, що відбувається в веблог.
+  * **writevlanmachistory** - робить опитування по влан термінаторам і заносить маки абонентів до таблиці, записує тільки якщо у якогось конкретного абонента змінився мак (дані бере зі своєї таблиці, і не має нічого спільного з маком у nethosts), так само визначає сумарну кількість онлайн абонентів (вланів).
+  * **dealwithit** - виконує для користувачів завдання, за поточну (та попередні) доби з планувальника "живи з цим".
+  * **mgqueue** - Здійснює заплановані відписки від тарифів Megogo
+  * **mgprocessing** - Здійснює нарахування АП за тарифами Megogo
+  * **mgfreecleanup** - Здійснює ліквідацію тестових підписок Megogo із простроченим періодом.
+  * **exhorse + [&ebobo=true]** - Здійснює збір даних та запис у базу, необхідних для роботи екзистенційного коня.
+  * **policedog** - Запускає швидке сканування собакою-поліціякою. Раз на півгодини-годину буде цілком нормально.
+  * **whydoyoucall** - Отримує дані з Askozia PBX про пропущені дзвінки.
+  * **whydoyoucallstats** - Записує статистику пропущених дзвінків за день у БД.
+  * **nasmon** - здійснює опитування серверів NAS з довідника на тему їхньої живості.
+  * **mtsigmonpoll** - проводить опитування Mikrotik, UBNT та інших бездротових пристроїв, для отримання рівнів сигналу.
+  * **sormcast** - проводить вивантажування даних в [[sormyahont|ИС СОРМ Яхонт]].
+  * **askozianum + [param mobilenumber]** - повертає стан користувача за номером його мобільного номера: 0 - не знайдено, 1 - знайдено і з ним все добре, 2 - боржник, 3 - відморозок.
+  * **freezedayscharge + [param debug2ublog]** - запускає процес обробки заморожених користувачів при увімкненому обмеженні кількості днів заморозки. Списує або нараховує доступні дні заморозки, а також відключає заморожування тим, хто вичерпав свої доступні дні заморозки. Необов'язковий параметр //debug2ublog// включає дебаг-режим та запис того, що відбувається в веблог. [[frozenchargedays|Докладніше]]
+  * **mikrotikdnshaper + [param downshift]** - запускає обробку правил динамічного шейпера для [[mikrotikapi|Mikrotik NAS]]. Опціональний параметр **downshift** вказує обробникові повернути користувачам швидкості відповідно до їх тарифних планів. [[dnswitchmtik|Докладніше]]
+  * **getagentdata + [param login]** - повертає JSON з даними про присвоєному користувачеві контрагента.
+  * **districtscache** - оновлює кеш присвоєних користувачам районів.
+  * **smszilla** + filterid + templateid + [translit]  - здійснює розсилку з заздалегідь заданими фільтрами з певним шаблоном та опціональним примусовим транслітом за допомогою [[smszilla|SMSZilla]].
+  * **multigen** - проводить швидку регенерацію всіх сценаріїв та відпрацювання необхідних сервісів [[multigen|КупаГен]].
+  * **multigentotal** - очищає всі сценарії, потім здійснює регенерацію всіх сценаріїв та виконує необхідні сервіси (не рекомендується використовувати просто так)
+  * **multigentraff** - агрегує статистику сесій з таблички акаунтингу та оновлює трафік користувачів stargazer-а.
+  * **multigenpod + [param login]** - шле PoD на NAS користувача з логіном вказаним у параметрі param. Керується опцією MULTIGEN_POD_ON_MAC_CHANGE.
+  * **onepunch + [param alias]** - запускает выполнение существующего [[onepunch|One-Punch]] скрипта.
+  * **paycardsqueue** - обробляє чергу платіжних карток і позначає їх як повністю "використані".
+  * **salarytelegram** - розсилає співробітникам [[salary|закриті]] на них роботи за день.
+  * **warehousetelegram** - розсилає співробітникам [[warehouse|заброньовані]] на них ТМЦ.
+  * **ddt** - викликає періодичну обробку тарифів судного дня.
+  * **visorcharge** - здійснює нарахування коштів для камер у разі їх дефіциту, в останній день місяця з основного облікового запису.
+  * **fdbarchive** - производит сохранение текущего кэша FDB для архива. При необходимости производит ротацию.
+  * **remotedhcp** - повертає дані, необхідні для синхронізації [[remotedhcp|віддаленими DHCP серверами]].
+  * **stgfeecharge2mysql** - створює кеш останніх списань коштів старгейзером з рахунку користувача для кожного логіну витягаючи це все з stargazer.log. Потрібно для коректної роботи функціонала, що включає опцію [[alteriniconf|alter.ini]] ONLINE_SHOW_LAST_FEECHARGE.
+  * **smartup** - вызов предназначен для обеспечения базовой интеграция c сервисом [[smartup|SmartUP]].
+  * **envyarchive** - сохраняет конфигурацию всех завистливых устройств в архиве.
+  * **autocredit** - вызывает [[autocredit|автоматическое кредитование]] особенных пользователей в последний день месяца.
+  * **sc** +[login,cr,end,fee,ct] - вызывает процедуру установки кредита пользователя.
+  * **pt** - вызывает обработку [[pt|Мощей тарифов]].
+  * **usercash** - денежные операции пользователя. Принимает параметры login (логин), summ(сумма денег), ct(тип оплат), op (add/correct/set/mock), note(примечание). Пример: usercash&login=sometestuser&summ=2&ct=1&op=correct&note=test
+  * **ptvchargefee** - производит начисление АП всем подписчикам [[prostotv|ProstoTV]].
+  * **karmaguard** - пытается автоматически чинить карму пользователям, у которых она по какой-то причине успела испортиться.
+  * **callmeback + [param number]** - создает новую заявку для модуля [[callmeback|Перезвоните мне пожалуйста]].
+  * **olltvchargefee** - производит тарификацию услуг [[olltv|OllTV]].
+  * **opayzsmsnotify** - запуск рассылки СМС уведомлений OpenPayz.
+  * **cachedog** - следит за инвалидацией кэша полных пользовательских данных. В момент вызова проверяется состояние всех пользователей и в случае если оно не соответствует закэшированному в ключе USER_ALL_DATA - последний просто сбрасывается.
+  * **telepony + number** - реагує на вхідний дзвінок [[telepony|TelePony]].
+  * **fastping** - опитує пристрої з довідника комутаторів на живість за допомогою [[fastping|FastPing]].
+  * **userbynum + number** - повертає [[userbynum|дані користувача за номером його стільникового]].
+  * **feesharvester** - реплікує дані про нарахування АП з логу Stargazer до БД. З додатковим параметром full - сканує весь лог за весь час, з параметром today - тільки за поточну добу, без параметрів - за поточний місяць.
+  * **btrxupd** - Пушить за наявності всі зміни в абонбазі для [[btrx24|CRM Bitrix24]]
+При неверных вызовах Remote API будет возвращать следующие исключения:
+  * ERROR:GET_NO_ACTION - не указана процедура которую следует вызвать
+  * ERROR:GET_WRONG_KEY - указан неверный серийный номер Ubilling
+  * ERROR:NO_UBSERIAL_EXISTS - не сгенерирован серийный номер Ubilling (можно узнать в модуле "Состояние системы")
+  * ERROR:GET_NO_KEY - не указан серийный номер Ubilling
+  * ERROR:API_DISABLED - Remote API отключена при помощи параметра REMOTEAPI_ENABLED=0 в alter.ini
+  * ERROR:GET_NO_PARAM - не указан объязательный параметр для вызова текущей процедуры (например логин пользователя)
+На данный момент вызовы reset и handlersrebuild используються для работы UHW. Пока что мы не хотим выносить слишком много излишнего функционала в это API в целях безопасности. Если вы хотите вызывать что-то из того что делает Ubilling в своих внешних приложениях - мы с удовольствием рассмотрим все предложения.
+Если требуется вызов каких-то процедур из API (а оно для этого и есть), можно оформить это в таком виде:
+<code bash>
+/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серийник&action=vserviceschargefee"
+</code>
+или так
+<code bash>
+/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серийник&action=swping"
+</code>
+Мысль надеюсь понятна.\\
+====== Страшні виклики навколо Asterisk ======
+  * **asterisk + [param login]** - дозволяє отримати логін клієнта за номером телефону
+  * **asterisk + [param realname]** - дозволяє отримати логін та ПІБ клієнта за номером телефону у вигляді **[login]-[ПІБ]**;
+  * **asterisk + [param swstatus]** - дозволяє отримати стан обладнання, до якого прив'язаний клієнт у білінгу за номером телефону (Відповідь буде: OK або DIE)
+  * **asterisk** - можливий наступний запит: **/?module=remoteapi&key=[ubserial]&action=asterisk&number=[mobile_number]&param=[login|realname|swstatus|userstatus|setcredit|paycardpay|setpause|setunpause|getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|addusermobile|getvservicescount|getonlinedaysleft|getcontragentdata|getuserspends]**
+    * //**&param=userstatus**// - дозволяє використовувати два цілком собі "self explanationary" додаткові параметри: **&ignorecache**=true и **&getmoney**=true
+    * //**&param=setcredit**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login, **&money**=123.45 и **&expiredays**=7.
+    * //**&param=paycardpay**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login і **&paycardnum**=987654321. Параметр **&paycardcashtype**=24 - необов'язковий, має на увазі ID типу оплат і за замовчуванням рівний 1.
+    * //**&param=setpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login.
+    * //**&param=setunpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. Наполегливо радимо використовувати цей функціонал дуже обережно, оскільки будь-яких спеціальних перевірок стану користувача перед розморожуванням не проводиться.
+    * //**&param=getuserdatabylogin**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. При використанні необов'язкового параметра **&userpass**=some_password буде проведена верифікація пари "логін + пароль" перед поверненням даних користувача.
+    * //**&param=getuserdatabymobile|getcontractsbymobile**// - не мають на увазі використання будь-яких додаткових параметрів, крім **&number=[mobile_number]** та їх дії/повертані дані цілком відповідають їх найменуванням.
+    * //**&param=addusermobile**// - окрім **&number=[mobile_number]** зобов'язує також використовувати параметр **&login**=some_user_login, що, як би, логічно. Необов'язковий параметр **&maxmobilesamnt**=4 показує максимальну кількість мобільних номерів однією користувача.
+    * //**getvservicescount**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину. Возвращает количество виртуальных сервисов, привязанных к определенному пользователю.
+    * //**getonlinedaysleft**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, чтобы включить стоимость виртуальных услуг в расчет "оставшихся дней в сети". Возвращает количество «оставшихся дней в сети» для определенного пользователя.
+    * //**getcontragentdata**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Возвращает данные связанного контрагента для определенного пользователя.
+    * //**getuserspends**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, для получения всех виртуальных услуг в дополнение к основному тарифу. Возвращает информацию о тарифе пользователя и его стоимости, а также, опционально, аналогичную информацию о виртуальных услугах пользователя в формате:
+<code php>
+        array(TarrifName => array('price' => TariffCost, 'daysperiod' => TariffChargePeriod),
+              Vservice1 => array('price' => Vservice1Cost, 'daysperiod' => Vservice1ChargePeriod),
+              Vservice2 => array('price' => Vservice2Cost, 'daysperiod' => Vservice2ChargePeriod),
+              VserviceN => array('price' => VserviceNCost, 'daysperiod' => VserviceChargePeriod)
+             )
+        //Примечание: "TarrifName => TariffCost" - всегда первый элемент массива
+</code>
+  *
+     * - ! -
+        * //* Стоит отметить, что **getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|getcontragentdata|getuserspends** возвращают данные в формате JSON.//\\
+        * //* Все значения дополнительных параметров, конечно же, указаны как пример.//\\
+====== Обгортка ======
+Для зручності та красивості, можна скористатися ось таким скриптом **/bin/ubapi** (не забуваємо chmod a+x /bin/ubapi):
+<file bash ubapi>
+#!/bin/sh
+#= Change this to your real  Ubilling serial ==
+UBSERIAL=UB000000000000000000000000000000000
+#==============================================
+if [ $# -ne 1 ]
+then
+  echo "Usage: /bin/ubapi \"action\""
+  echo "Example: /bin/ubapi \"backupdb\" or /bin/ubapi \"swping\""
+  exit
+fi
+ACTION=$1
+/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=${UBSERIAL}&action=${ACTION}"
+</file>
+Починаючи з релізу 0.8.0, одразу після встановлення, він вже лежить по потрібному шляху. Та в нього вже вписано серійник вашого Ubilling. Тобто просто можете користуватись.
+====== А далі що? ======
+І як тепер виглядатиме crontab -e у мінімальному джентльменському наборі? А от якось так:
+<code bash>
+1 1 * *      /bin/ubapi "vserviceschargefee"
+*/20 * * * *    /bin/ubapi "swping"
+*/10 * * * *    /bin/ubapi "fastping"
+* * * *       /bin/ubapi "fullhostscan&param=traffdiff&nn=1"
+*/1 * * *     /bin/ubapi "swpoll"
+*/10 * * * *    /bin/ubapi "watchdog"
+*/5 * * * *     /bin/ubapi "senddog"
+1 * * *       /bin/ubapi "backupdb"
+* * * *       /bin/ubapi "rebuildglscache"
+2 * * *      /bin/ubapi "dealwithit"
+23 * * *     /bin/ubapi "exhorse"
+*/10 * * * *    /bin/ubapi "nasmon"
+*/30 * * * *    /bin/ubapi "mtsigmonpoll"
+10 1 * *     /bin/ubapi "autocleandb"
+*/1 * * *    /bin/ubapi "fdbarchive"
+*/10 * * * *    /bin/ubapi "oltpoll"
+*/20 * * * *    /bin/ubapi "cachedog"
+*/2 * * * *     /bin/ubapi "multigen"
+0 * * *      /bin/ubapi "feesharvester"
+</code>
+Це необхідний мінімум(!) для забезпечення мінімально робочого стану Ubilling.

Ubilling Wiki

Користувальницькькі налаштування

Налаштування сайту

Розбіжності

Налаштування сторінки