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

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


remoteapi

Розбіжності

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

Посилання на цей список змін

Порівняння попередніх версій Попередня ревізія
Наступна ревізія
Попередня ревізія
Наступна ревізія По сторонах наступні версії
remoteapi [2023/06/15 17:51]
nightfly
remoteapi [2024/01/02 17:55]
nightfly
Рядок 54: Рядок 54:
   * **nasmon** - здійснює опитування серверів NAS з довідника на тему їхньої живості.   * **nasmon** - здійснює опитування серверів NAS з довідника на тему їхньої живості.
   * **mtsigmonpoll** - проводить опитування Mikrotik, UBNT та інших бездротових пристроїв, для отримання рівнів сигналу.   * **mtsigmonpoll** - проводить опитування Mikrotik, UBNT та інших бездротових пристроїв, для отримання рівнів сигналу.
-  * **sormcast** - проводить вивантажування даних в [[sormyahont|ИС СОРМ Яхонт]].+  * **sormcast** - проводить вивантажування даних в ИС СОРМ Яхонт.
   * **askozianum + [param mobilenumber]** - повертає стан користувача за номером його мобільного номера: 0 - не знайдено, 1 - знайдено і з ним все добре, 2 - боржник, 3 - відморозок.   * **askozianum + [param mobilenumber]** - повертає стан користувача за номером його мобільного номера: 0 - не знайдено, 1 - знайдено і з ним все добре, 2 - боржник, 3 - відморозок.
   * **freezedayscharge + [param debug2ublog]** - запускає процес обробки заморожених користувачів при увімкненому обмеженні кількості днів заморозки. Списує або нараховує доступні дні заморозки, а також відключає заморожування тим, хто вичерпав свої доступні дні заморозки. Необов'язковий параметр //debug2ublog// включає дебаг-режим та запис того, що відбувається в веблог. [[frozenchargedays|Докладніше]]   * **freezedayscharge + [param debug2ublog]** - запускає процес обробки заморожених користувачів при увімкненому обмеженні кількості днів заморозки. Списує або нараховує доступні дні заморозки, а також відключає заморожування тим, хто вичерпав свої доступні дні заморозки. Необов'язковий параметр //debug2ublog// включає дебаг-режим та запис того, що відбувається в веблог. [[frozenchargedays|Докладніше]]
Рядок 74: Рядок 74:
   * **remotedhcp** - повертає дані, необхідні для синхронізації [[remotedhcp|віддаленими DHCP серверами]].   * **remotedhcp** - повертає дані, необхідні для синхронізації [[remotedhcp|віддаленими DHCP серверами]].
   * **stgfeecharge2mysql** - створює кеш останніх списань коштів старгейзером з рахунку користувача для кожного логіну витягаючи це все з stargazer.log. Потрібно для коректної роботи функціонала, що включає опцію [[alteriniconf|alter.ini]] ONLINE_SHOW_LAST_FEECHARGE.   * **stgfeecharge2mysql** - створює кеш останніх списань коштів старгейзером з рахунку користувача для кожного логіну витягаючи це все з stargazer.log. Потрібно для коректної роботи функціонала, що включає опцію [[alteriniconf|alter.ini]] ONLINE_SHOW_LAST_FEECHARGE.
-  * **smartup** - вызов предназначен для обеспечения базовой интеграция c сервисом [[smartup|SmartUP]]. +  * **smartup** - виклик призначений для забезпечення базової інтеграції з сервісом [[smartup|SmartUP]]. 
-  * **envyarchive** - сохраняет конфигурацию всех завистливых устройств в архиве+  * **envyarchive** - зберігає конфігурацію всіх активних заздрісних пристроїв у архіві
-  * **autocredit** - вызывает [[autocredit|автоматическое кредитование]] особенных пользователей в последний день месяца+  * **autocredit** - викликає [[autocredit|автоматичне кредитування]] особливих користувачів в останній день місяця.  
-  * **sc** +[login,cr,end,fee,ct] - вызывает процедуру установки кредита пользователя+  * **sc** +[login,cr,end,fee,ct] - викликає процедуру встановлення кредиту користувача
-  * **pt** - вызывает обработку [[pt|Мощей тарифов]]. +  * **pt** - викликає обробку [[pt|Могутніх тарифів]]. 
-  * **usercash** - денежные операции пользователя. Принимает параметры login (логин), summ(сумма денег), ct(тип оплат), op (add/correct/set/mock), note(примечание). Пример: usercash&login=sometestuser&summ=2&ct=1&op=correct&note=test +  * **usercash** -  Фінансові операції користувача. Приймає параметри login (логін), summ(сума грошей), ct(тип оплати), op (add/correct/set/mock), note(примітка). Приклад: usercash&login=sometestuser&summ=2&ct=1&op=correct&note=test 
-  * **ptvchargefee** - производит начисление АП всем подписчикам [[prostotv|ProstoTV]]. +  * **ptvchargefee** - здійснює нарахування АП всім передплатникам [[prostotv|ProstoTV]]. 
-  * **karmaguard** - пытается автоматически чинить карму пользователям, у которых она по какой-то причине успела испортиться. +  * **karmaguard** - намагається автоматично ремонтувати карму користувачам, у яких вона з якоїсь причини встигла зіпсуватися. 
-  * **callmeback + [param number]** - создает новую заявку для модуля [[callmeback|Перезвоните мне пожалуйста]]. +  * **callmeback + [param number]** - створює нову заявку для модуля [[callmeback|Передзвоніть мені будь ласка]]. 
-  * **olltvchargefee** - производит тарификацию услуг [[olltv|OllTV]]. +  * **olltvchargefee** - здійснює тарифікацію послуг [[olltv|OllTV]]. 
-  * **opayzsmsnotify** - запуск рассылки СМС уведомлений OpenPayz. +  * **opayzsmsnotify** - запуск розсилки SMS сповіщень OpenPayz. 
-  * **cachedog** - следит за инвалидацией кэша полных пользовательских данных. В момент вызова проверяется состояние всех пользователей и в случае если оно не соответствует закэшированному в ключе USER_ALL_DATA - последний просто сбрасывается.+  * **cachedog** - стежить за інвалідацією кешу повних даних користувачаУ момент виклику перевіряється стан всіх користувачів і якщо вінне відповідає закешованому в ключі USER_ALL_DATA - останній просто прибивається.
   * **telepony + number** - реагує на вхідний дзвінок [[telepony|TelePony]].   * **telepony + number** - реагує на вхідний дзвінок [[telepony|TelePony]].
   * **fastping** - опитує пристрої з довідника комутаторів на живість за допомогою [[fastping|FastPing]].   * **fastping** - опитує пристрої з довідника комутаторів на живість за допомогою [[fastping|FastPing]].
Рядок 91: Рядок 91:
   * **feesharvester** - реплікує дані про нарахування АП з логу Stargazer до БД. З додатковим параметром full - сканує весь лог за весь час, з параметром today - тільки за поточну добу, без параметрів - за поточний місяць.   * **feesharvester** - реплікує дані про нарахування АП з логу Stargazer до БД. З додатковим параметром full - сканує весь лог за весь час, з параметром today - тільки за поточну добу, без параметрів - за поточний місяць.
   * **btrxupd** - Пушить за наявності всі зміни в абонбазі для [[btrx24|CRM Bitrix24]]   * **btrxupd** - Пушить за наявності всі зміни в абонбазі для [[btrx24|CRM Bitrix24]]
 +  * **btrxpolls** - пушить дані про всі наявні опитування та їх результати до [[btrx24|CRM Bitrix24]]
 +  * **setculpa + [login,culpa]** - встановлює користувачу login кульпу вказану в culpa
 +  * **pseudocrm + [param]** - виконує відповідний виклик функцій вказахнив в param з [[pseudocrm|PseudoCRM]].
 +  * **stickynotify** - виконує розсилку в Telegram всім активним працівникам, з кількістю їх активних персональних нотаток та нагадувань "на сьогодні".
 +  * **taskmannotify** - виконує розсилку в Telegram всім активним працівникам, з кількістю запланованих на них задач планувальника задач "на сьогодні".
 +  * **ophanimtraff** - виконує синхронізацію локальної БД з даними джерел [[ophanimflow|OphanimFlow]].
  
-При неверных вызовах 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 - не указан объязательный параметр для вызова текущей процедуры (например логин пользователя) 
  
 +У разі неправильних викликів Remote API повертатиме наступні помилки:
  
-На данный момент вызовы reset и handlersrebuild используються для работы UHW. Пока что мы не хотим выносить слишком много излишнего функционала в это API в целях безопасности. Если вы хотите вызывать чтоо из того что делает Ubilling в своих внешних приложениях - мы с удовольствием рассмотрим все предложения.+  * 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 - не вказано обов'язковий параметр для виклику поточної процедури (наприклад, логін користувача)
  
-Если требуется вызов каких-то процедур из API (а оно для этого и есть), можно оформить это в таком виде:+ 
 +Якщо потрібно звідкись ззовні викликати якісь процедури з API (а воно для цього і є), можна оформити це в такому вигляді:
  
 <code bash>  <code bash> 
-/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серийник&action=vserviceschargefee"+/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серійник&action=vserviceschargefee"
 </code> </code>
-или так+ 
 +або так 
 <code bash>  <code bash> 
-/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серийник&action=swping"+/usr/local/bin/curl -o /dev/null "http://127.0.0.1/billing/?module=remoteapi&key=ваш_серійник&action=swping"
 </code> </code>
  
-Мысль надеюсь понятна.\\+Думка сподіваємось зрозуміла\\
  
 ====== Страшні виклики навколо Asterisk ====== ====== Страшні виклики навколо Asterisk ======
Рядок 129: Рядок 137:
     * //**&param=getuserdatabymobile|getcontractsbymobile**// - не мають на увазі використання будь-яких додаткових параметрів, крім **&number=[mobile_number]** та їх дії/повертані дані цілком відповідають їх найменуванням.     * //**&param=getuserdatabymobile|getcontractsbymobile**// - не мають на увазі використання будь-яких додаткових параметрів, крім **&number=[mobile_number]** та їх дії/повертані дані цілком відповідають їх найменуванням.
     * //**&param=addusermobile**// - окрім **&number=[mobile_number]** зобов'язує також використовувати параметр **&login**=some_user_login, що, як би, логічно. Необов'язковий параметр **&maxmobilesamnt**=4 показує максимальну кількість мобільних номерів однією користувача.     * //**&param=addusermobile**// - окрім **&number=[mobile_number]** зобов'язує також використовувати параметр **&login**=some_user_login, що, як би, логічно. Необов'язковий параметр **&maxmobilesamnt**=4 показує максимальну кількість мобільних номерів однією користувача.
-    * //**getvservicescount**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину. Возвращает количество виртуальных сервисов, привязанных к определенному пользователю+    * //**getvservicescount**// - **має на увазі** можливість пошуку користувача за номером телефону **&number=[mobile_number]** або логіну. Повертає кількість віртуальних сервісів, прив'язаних до певного користувача
-    * //**getonlinedaysleft**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, чтобы включить стоимость виртуальных услуг в расчет "оставшихся дней в сети"Возвращает количество «оставшихся дней в сети» для определенного пользователя+    * //**getonlinedaysleft**// - **має на увазі можливість пошуку користувача за номером телефону **&number=[mobile_number]** або логіну **&login**=some_user_login. Ви також можете використовувати параметр **includevsrvs=true**, щоб включити вартість віртуальних послуг у розрахунок днів, що залишилися в мережіПовертає кількість днів, що «залишилися в мережі» для певного користувача
-    * //**getcontragentdata**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Возвращает данные связанного контрагента для определенного пользователя+    * //**getcontragentdata**// - **має на увазі можливість пошуку користувача за номером телефону **&number=[mobile_number]** або логіну **&login**=some_user_login. Повертає дані пов'язаного контрагента для певного користувача
-    * //**getuserspends**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**для получения всех виртуальных услуг в дополнение к основному тарифу. Возвращает информацию о тарифе пользователя и его стоимости, а также, опционально, аналогичную информацию о виртуальных услугах пользователя в формате:+    * //**getuserspends**// - **має на увазі** можливість пошуку користувача за номером телефону **&number=[mobile_number]** або логіну **&login**=some_user_login. Ви також можете використовувати параметр **includevsrvs=true** для отримання всіх віртуальних послуг на додаток до основного тарифу. Повертає інформацію про тариф користувача та його вартість, а також, опціонально, аналогічну інформацію про віртуальні послуги користувача у форматі:
 <code php> <code php>
         array(TarrifName => array('price' => TariffCost, 'daysperiod' => TariffChargePeriod),         array(TarrifName => array('price' => TariffCost, 'daysperiod' => TariffChargePeriod),
Рядок 139: Рядок 147:
               VserviceN => array('price' => VserviceNCost, 'daysperiod' => VserviceChargePeriod)               VserviceN => array('price' => VserviceNCost, 'daysperiod' => VserviceChargePeriod)
              )              )
-        //Примечание: "TarrifName => TariffCost" - всегда первый элемент массива+        //Примітка: "TarrifName => TariffCost"завжди перший елемент масиву
 </code> </code>
   *   *
      * - ! -      * - ! -
-        * //* Стоит отметитьчто **getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|getcontragentdata|getuserspends** возвращают данные в формате JSON.//\\ +        * //* Варто зазначити, що **getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|getcontragentdata|getuserspends** повертають дані у форматі JSON.//\\ 
-        * //* Все значения дополнительных параметров, конечно жеуказаны как пример.//\\+        * //* Всі значення додаткових параметрів, звичайно, вказані як приклад.//\\
  
  
remoteapi.txt · Востаннє змінено: 2024/05/15 14:31 повз bobr