|
Ключ
Эта строка удалена.
Это слово было удалено. Это слово было добавлено.
Эта строка добавлена.
|
Комментарий:
Исправлена опечатка
Изменения (1)
просмотр истории страницы... h1. API личного кабинета _Работает только с разрешенного IP_ # Авторизация по логину и паролю учетной записи Логин testlogin, пароль testpsw {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.login&arg1={"login":"testlogin","passwd":"testpsw"} {code} # Авторизация по IP. Параметром передаётся IP, с которого производится авторизация - 10.20.30.41 {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.try_auto_login&arg1={"src_ip":"10.20.30.41"} {code} После авторизации будет получен уникальный ID сессии по которому возможно авторизовать все прочие запросы на получение данных и изменение абонента, например Вы получили ID 54ds34jklji8ufds8u945jkl, то это значение передается в параметре suid. # Получить информацию об абоненте {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.user_info&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_user_info_sensitive&arg1={"contract_number":"testabonent","src_ip":"10.20.30.41","suid":"54ds34jklji8ufds8u945jkl"} {code} {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_user&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # [CarbonBilling:Восстановление пароля к личному кабинету]. Отправляет проверочный код абоненту. {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.reset_password&arg1={"login":"testlogin","base_url":null} {code} # [CarbonBilling:Восстановление пароля к личному кабинету]. Меняет пароль на указанный, по token из сообщения абоненту. {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.submit_password&arg1={"token":"F7987Z","uid":"324","psw1":"newpsw","psw2":"newpsw"} {code} # Изменить данные абонента {code} |
| http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.set_user_info&arg1={"email":"test","sms":"+7999555555","user_mac":"00-B0-D0-63-C2-26","user_ask_password_lk":true,"user_password":"secrettest","limit_warning":"100.10","attrib_30":"test","suid":"54ds34jklji8ufds8u945jkl"} {code} |
| # Установить абоненту токен [CarbonBilling:PUSH-уведомления [АРХИВ PUSH-уведомления из личного кабинета] |
| {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.save_push_token&arg1={"token":"testtoken","src_ip":"10.20.30.41","suid":"54ds34jklji8ufds8u945jkl"} |
... {code} # Проверка некоторых параметров. Возможные значения параметра what_check перечислены в статье про шорткод [cabinet_check|CarbonBilling:Wordpress. Список шорткодов ЛК.]. {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.check&arg1={"what_check":"empty_phone","suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить абонентскую плату за сегодня {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_abon_pay_for_today&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # [Прогнозируемая дата блокировки|CarbonBilling:Финансовые операции. Учет НДС]. {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_balance_until_date&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить список тарифов {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_tarifs&arg1={"show_all":false,"show_www":false,"show_archived":false,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Список услуг {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_usluga_list&arg1={"filter":"","get_user_uslugas_all":false,"get_user_uslugas":false,"get_setted":false,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Список подписок Megogo {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_megogo_services&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Список учётных записей IPTV {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_iptv_accounts&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Подключение услуги {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.set_user_usluga&arg1={"usluga_id":"96","suid":"54ds34jklji8ufds8u945jkl"} {code} # Отключение услуги {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.remove_user_usluga&arg1={"usluga_id":"96","suid":"54ds34jklji8ufds8u945jkl"} {code} # Подключить или отключить услугу {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.toggle_user_usluga&arg1={"usluga_id":"96","suid":"54ds34jklji8ufds8u945jkl"} {code} # Включение или выключение интернета по желанию абонента {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.toogle_block&arg1={"block_type":"b_own2","suid":"54ds34jklji8ufds8u945jkl"} {code} # Включить добровольную блокировку {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.block_user&arg1={"start_date":"01.01.2024","end_date":"01.02.2024","suid":"54ds34jklji8ufds8u945jkl"} {code} # Отключить добровольную блокировку {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.disable_own_block&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить историю платежей {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_pay_log&arg1={"start_date":"01.01.2022","end_date":"01.01.2024","page_number":1,"per_page":50,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить историю списаний {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_credit_log&arg1={"start_date":"01.01.2022","end_date":"01.01.2024","page_number":1,"per_page":50,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить историю потребления трафика {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_traffic_log&arg1={"start_date":"01.01.2022","end_date":"01.01.2024","page_number":1,"per_page":50,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить историю звонков {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_voip_log&arg1={"start_date":"01.01.2023","end_date":"01.02.2023","page_number":1,"per_page":50,"suid":"54ds34jklji8ufds8u945jkl"} {code} {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_voip_log_fullrange&arg1={"start_date":"01.01.2023","end_date":"01.02.2023","suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить стоимость звонков {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_voip_log_fullrange_billsum&arg1={"start_date":"01.01.2023","end_date":"01.02.2023","suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить текущий тариф {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_user_tarif&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Сменить тариф {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.change_user_tarif&arg1={"tarif_id":1,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить список обещанных платежей доступных в ЛК {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_promise_pay_list&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить обещанный платеж {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_promise_pay&arg1={"promise_pay_id":null,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Подключить обещанный платёж {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.add_promise_pay&arg1={"promise_pay_id":null,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить логин учётной записи и ID абонента {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_user_login&arg1={"user_id":324,"suid":"54ds34jklji8ufds8u945jkl"} {code} # Получить уведомления {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_notifications_for_user&arg1={"suid":"54ds34jklji8ufds8u945jkl"} {code} # Инициализация начала проведения платежа (тип операции ADD) {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.add_payment_operation&arg1={"suid": "54ds34jklji8ufds8u945jkl", "contract_number": "BILL0000007", "summa_in": "100.00", "operator": "SBERBANK_ACQ", "src_ip": "10.20.30.41"} {code} # Инициализация начала проведения платежа (тип операции ADD) без авторизации. Используется в [CarbonBilling:Форма для оплаты без авторизации Альфа-Банк (Интернет Эквайринг)] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.add_payment_operation_direct&arg1={"suid": null, "contract_number": "BILL0000007", "summa_in": "100.00", "operator": "SBERBANK_ACQ", "src_ip": "10.20.30.41"} {code} # Обновление данных о платеже. {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.update_payment_operation&arg1={"suid": "54ds34jklji8ufds8u945jkl", "action": "ID", "operation_id": "1", "new_operation_id": "222", "new_ext_id": "333", "text": "комментарий", "operator": "SBERBANK_ACQ"} {code} # Обновление данных о платеже без авторизации. Используется в [CarbonBilling:Форма для оплаты без авторизации Альфа-Банк (Интернет Эквайринг)] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.update_payment_operation_direct&arg1={"contract_number": "BILL0000007", "action": "ID", "operation_id": "1", "new_operation_id": "222", "new_ext_id": "333", "text": "комментарий", "operator": "SBERBANK_ACQ"} {code} # Получить информацию из журнала платежей {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_payment_operation&arg1={"suid": "54ds34jklji8ufds8u945jkl", "operation_id": "1"} {code} # Включение автоплатежа (требует оплаты) {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.add_autopay_payment_operation&arg1={"suid": "54ds34jklji8ufds8u945jkl", "operator": "PAYMASTER", "src_ip": "10.20.30.41"} {code} # Отключение автоплатежа {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.disable_autopay&arg1={"suid": "54ds34jklji8ufds8u945jkl", "src_ip": "10.20.30.41"} {code} # Информация об автоплатеже {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_autopay_info&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Платеж через карту оплаты {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.add_card_payment_operation&arg1={"suid": "54ds34jklji8ufds8u945jkl", "series_no": "123", "card_key": "321", "src_ip": "10.20.30.41"} {code} # Самый дорогой из доступных тарифов {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_best_tarif&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Информация о лицевом счёте {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_account_info&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Статус абонента (тариф, блокировка, дата активации) {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_abonent_status&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Расходы за месяц по услугам {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_month_expenses&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Дерево домов {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_homes_tree&arg1={} {code} # [CarbonBilling:Заявка на подключение], обязательные поля contact_name и phone_number {code} http://10.90.214.4:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.apply_for_connection&arg1={"contact_name": "Иван", "phone_number": "+7999555555", "contact_email": "", "home": 1, "comment": "Подключение с Интернету", "operator_id": 3} {code} # [CarbonBilling:CRM. HelpDesk] Список заявок {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_helpdesk_dialogs&arg1={"suid": "54ds34jklji8ufds8u945jkl", "parent_id": null} {code} # [CarbonBilling:CRM. HelpDesk] Комментарии к заявке {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_helpdesk_comments&arg1={"suid": "54ds34jklji8ufds8u945jkl", "parent_id": 1} {code} # [CarbonBilling:CRM. HelpDesk] Создать заявку или добавить комментарий {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.create_ticket&arg1={"suid": "54ds34jklji8ufds8u945jkl", "ticket_text": "Прошу помочь", "subj": "Заявка", "parent_id": null, "status": 1} {code} # Получить USER ID {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_user_id&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Краткая сводка о расходах и приходах {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_simple_statistics&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # История смены тарифов через "Дата следующего перехода" в карточке абонента {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_tarif_change_history&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Пробует определить MAC пользователя, отправив событие user_get_mac на оборудование, а потом записать его в учётную запись {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.change_mac&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Всегда возвращает status=1 {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.service_status&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # [CarbonBilling:Глобальные настройки биллинга и оператора] Доступны: 170004 {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_vpn_const&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Проверка на вход учётной записи в служебную группу {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.is_admin&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Список доступных для скачивания документов {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.pdf_list&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Скачать документ в PDF по ID финансовой операции {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_pdf&arg1={"suid": "54ds34jklji8ufds8u945jkl", "operation_id": 13243} {code} # Получение данных Radius-сессий для СОРМ, используется в шорткоде cabinet_detail_search {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.detail_search&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # Выполнение отчёта, подробнее в [CarbonBilling:Отчёты в личном кабинете] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.report_exec&arg1={"suid": "54ds34jklji8ufds8u945jkl", "report_id": 1, "args":{}} {code} Передать параметры в отчёт: {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.report_exec&arg1={"suid": "54ds34jklji8ufds8u945jkl", "report_id": 1, "args":{"date_start|date":"01.10.2024", "date_end|date":"31.10.2024" }} {code} В каждом запросе автоматически передаётся параметр *abonent_id* содержащий *ID*, авторизованного абонента. # Получить наборы правил [CarbonBilling:Правила и сети] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_subnet_list&arg1={"suid": "54ds34jklji8ufds8u945jkl"} {code} # [CarbonBilling:Конвертация баллов] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.convert_bonus&arg1={"suid": "54ds34jklji8ufds8u945jkl", "src_ip": "10.20.30.41", "bonus_value": "10.00"} {code} # Список домов {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.get_all_homes&arg1={} {code} # [CarbonBilling:Перевод денег другу] {code} http://169.254.80.82:8082/system_api/?format=json&context=web&model=users&method1=web_cabinet.transfer_money&arg1={"suid": "54ds34jklji8ufds8u945jkl", "amount": "10.00", "to": "BILL0000012"} {code} {info} Более подробно о параметрах на примере пункта 35: suid - уникальный ID сессии; operation_id - текущий ID платежа (pay_id_str_in); operator - платёжная система (pay_operator), если указана, то участвует в поиске записи в журнале платежей (так как может быть ситуация с одинаковыми идентификаторами платежей в разных платёжных системах); action - какой параметр записи в журнале платежей необходимо изменить: ID - меняет ID платежа в биллинге (pay_id_str_in) EXT_ID - меняет внешний ID, идентификатор платежа внутри платёжной системы (ext_id) COMMENT - поле комментарий (comment_out); new_operation_id - если изменяется ID, то в параметре указывается новое значение; new_ext_id - если изменяется EXT_ID, то в параметре указывается новое значение; text - если изменяется COMMENT, то в параметре указывается новое значение; В аудит абонента записывается: "Обновление информации % по платежу pk % #% из ЛК"; В ответе на запрос: operation_id_out: ID платежа (pay_id_str_in) ext_id: Внешний ID (ext_id) comment_out: Комментарий (comment_out). {info} |