API REST v2.0

Старый API после некоторых доработок потерял совместимость, поэтому мы решили выпустить вторую версию.

{toc:maxLevel=3}

Рекомендуем использовать эту версию для написания запросов.
Формат дат для параметров запросов:
{code}
%Y-%m-%d %H:%M:%S
{code}
{code}
%Y-%m-%d
{code}
Отличия от старой версии:
* Новый адрес для запросов: http://<ip>:8082/rest_api/v2/
* Вместо передачи параметров в GET, перешли на POST
* Убрали из вывода результаты промежуточных вызовов (method1, method2,..), оставили только result
* Соответственно, немного поменялся схема вывода (см. соответствующий раздел)
* Модель указывается в url напрямую, например: http://<ip>:8082/rest_api/v2/Abonents/
* Атрибут запроса fields теперь не нужно маркировать номером метода. Он будет применяться к последнему объекту (возвращенному последним методом)
* Документацию (пока что только перечень доступных полей для запроса) можно посмотреть, пройдя браузером по ссылке http://<ip>:8082/rest_api/v2/
* Теперь можно в fields запрашивать вывод объектов по ссылкам (fk, m2m), обратным ссылкам и выводить property объектов, а также выводить конкретные поля этих объектов. Глубина запроса не ограничена, разделитель - двойное подчеркивание. \*Внимание\! Django не объединяет запрос по обратной ссылке в один, поэтому он может выполняться заметно дольше для большого кол-ва объектов (например, если запросить все учетные записи у всех абонентов - будет 1 запрос для абонентов и по запросу на каждого абонента для получения его учетных записей)

h2. Описание формата

*Формат ответа:

{code}
{"call": "/rest_api/v2/<model_name>/", "result": [<объект>, ...]}
{code}

тип поля result будет меняться в соответствии с данными (список для перечня объектов (objects.filter), словарь для 1 объекта (objects.get), значение метода при вызове метода и.т.д).

*Формат ошибки:

{code}
{"call": "/rest_api/v2/<model_name>/", "error": "..."}
{code}

если в результате есть не пустое поле error, то значит запрос завершился неуспешно

*Формат объекта:

{code}
{"pk": <id>, "model": "<model>", "fields": {"<field>": <value>, ...}
{code}

Если поле является ссылкой fk (например поле tarif у модели Abonents), то объект тарифа можно получить, задав fields=\["tarif"\], а pk тарифа, задав fields=\["tarif_id"\], например:

{code}
{"pk": <id>, "model": "Abonents", "fields": {"tarif": {"pk": <id тарифа>, "model": "Tarif", "fields": {<поля тарифа>}, "tarif_id": <id тарифа>}
{code}

Также, можно вывести только определенные поля тарифа через двойное подчеркивание: fields=\["tarif__name"\]:

{code}
{"pk": <id>, "model": "Abonents", "fields": {"tarif": {"pk": <id тарифа>, "model": "Tarif", "fields": {"name": <имя тарифа>}, "tarif_id": <id тарифа>}
{code}

Еще пример. Запрос ip адресов всех учетных записей абонента fields=\["abonent_id_users__ip"\]:

{code}
{"pk": <id>, "model": "Abonents", "fields": {"abonent_id_users": [{"pk": <id учетной записи>, "model": "Users", "fields": {"ip": "<ip>"}}, ...]}}
{code}

Если необходимо выбрать данные в диапазоне, можно использовать \__range:

{code}
{method1=objects.filter&arg1={"abonent_id": <id>,"s_time__range":["2018-10-01", "2018-11-01"]}
{code}


h3. Формирование запросов

{code}
curl -XPOST -d 'method1=objects.all&arg1={}&fields=["tarif_id","tarif","abonent_id_users__ip","attr","child_folders_count"]' http://<ip>:8082/rest_api/v2/Abonents/ -D -
curl -XPOST -d 'method1=objects.all&arg1={}&fields=["tarif_id","tarif__name","tarif__reserve_plan","abonent_id_users__ip","attr","child_folders_count"]' http://<ip>:8082/rest_api/v2/Abonents/ -D -
{code}

h3. Документация по методам и моделям

Вызовите в браузере http://<ip>:8082/rest_api/v2/ и выберите интересующую модель.

Например, демо:

[http://demo5.carbonsoft.ru/rest_api/v2/]


h2. Примеры

Некоторые готовые примеры работы с API с помощью Python вы можете посмотреть здесь: [github|https://github.com/carbonsoft/rest_api_example]

# h5. Вывести абонентов, у которых есть учетная запись с ip = 127.1.2.3
{code}
curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id_users__ip":"127.1.2.3"}' http://<ip>:8082/rest_api/v2/Abonents/ -D -
{code}
или количество таких абонентов:
{code}
curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id_users__ip":"127.1.2.3"}&method2=count&arg2={}' http://<ip>:8082/rest_api/v2/Abonents/ -D -
{code}
# h5. Установить абоненту с id = 45 номер квартиры 3
{code}
curl -XPOST 'http://<ip>:8082/rest_api/v2/Abonents/' --data 'method1=objects.get&arg1={"id":"45"}&method2=set&arg2={"a_home_number":"3"}&method3=save&arg3={}';
{code}
# h5. Подключение услуги id=532 абоненту с номером договора BILL0000021
{code}
curl -XPOST -d 'http://<ip>:8082/rest_api/v2/Abonents/' --data 'method1=objects.get&arg1={"contract_number":"BILL0000021"}&method2=add_service&arg2={"usluga_id":532}'
{code}
# h5. Сколько абоненту с номером договора 1005633 нужно заплатить что проработать до 2016-10-20
{code}
curl -XPOST -d 'method1=objects.get&arg1={"contract_number":"1005633"}&method2=get_credit_for&arg2={"end_credit_date":"2016-10-20"}' http://169.1.80.82:8082/rest_api/v2/Abonents/
{code}
# h5. Выполнение отчёта 1003 с параметром phone="+79222222222"
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":1003}&method2=get_data&arg2={"phone":"+79222222222"}' http://169.1.80.82:8082/rest_api/v2/AdminCustomReports/ -D -
{code}
# h5. По абоненту с id=1383 вывести значение реквизита с id=26
{code}
curl -XPOST -d 'method1=objects.filter&arg1={"abonent":"1383", "attribute":"26"}' http://<ip-биллинга>:8082/rest_api/v2/AttributeValues/ -D -
{code}
# h5. Пример создания абонента с именем abonent, в папке 1 с тарифом с id 1
{code}
def create_abonent(self, **kwargs):
params = {
'url': '(billing_url)/Abonents/'.format(self.api_url),
'method1': 'objects.create',
'arg1': {"name": "abonent", '"parent_id": 1,"tarif_id": 1}.
}
return self.get_api_result(self.post_request(**params))
{code}
# h5. Установить абоненту с id 1321 тариф с именем Тестовый
1. Получаем id тарифа по имени
{code}
curl -XPOST -d 'method1=objects.get&arg1={"name":"Тестовый"}' http://<ip-биллинга>:8082/rest_api/v2/tarif/ -D -
{code}
В поле pk получаем id тарифа, в данном случае 1118
2. Устанавливаем тариф абоненту по id
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1321"}&method2=set&arg2={"tarif_id":"1118"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Abonents/ -D -
{code}
# h5. Установить абоненту с номером учетной записи 1361 коммутатор с IP 1.1.1.1
1. Получаем id коммутатора по IP
{code}
curl -XPOST -d 'method1=objects.get&arg1={"ip":"1.1.1.1"}' http://<ip-биллинга>:8082/rest_api/v2/Switch/ -D -
{code}
В поле pk получаем id коммутатора, в данном случае 1113
2. Устанавливаем коммутатор в учетную запись по id
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1361"}&method2=set&arg2={"switch_id":"1113"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить абоненту с номером учетной записи 1361 vlan 8
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1361"}&method2=set&arg2={"router_vlan":"8"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить абоненту с номером учетной записи 1361 mac-адрес 00:AA:CC:11:44:88
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1361"}&method2=set&arg2={"mac":"00:AA:CC:11:44:88"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить абоненту с номером учетной записи 1361 галочку opt82
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1361"}&method2=set&arg2={"opt82":"1"}&method3=save&arg3={}' http://10.90.180.180:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить абоненту с номером учетной записи 1361 порт номер 8 коммутатора 2.2.2.2
1. Получаем id коммутатора по IP
{code}
curl -XPOST -d 'method1=objects.get&arg1={"ip":"2.2.2.2"}' http://<ip-биллинга>:8082/rest_api/v2/Switch/ -D -
{code}
В поле pk получаем id коммутатора, в данном случае 1114
2. Получаем id порта по его номеру
{code}
curl -XPOST -d 'method1=objects.get&arg1={"switch_id":"1114","num":"8"}' http://<ip-биллинга>:8082/rest_api/v2/SwitchPorts/ -D -
{code}
В поле pk получаем id порта коммутатора, в данном случае 1168
3. Устанавливаем порт в учетной записи по id порта из БД
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1361"}&method2=set&arg2={"switch_p":"1168"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить абоненту с id 1321 заявку на смену тарифа с именем "Другой" на 2016-05-26
1. Получаем id тарифа по имени
{code}
curl -XPOST -d 'method1=objects.get&arg1={"name":"Другой"}' http://<ip-биллинга>:8082/rest_api/v2/tarif/ -D -
{code}
В поле pk получаем id тарифа, в данном случае 1119
2. Добавляем заявку на смену и дату смены
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1321"}&method2=set&arg2={"tarif_next_id":"1119","tarif_next_date":"2016-05-26"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/Abonents/ -D
{code}
# h5. Создание абонента и добавление ему учетной записи
1. Создаем абонента abonent с тарифом Основной(id=1) в группе Все (id=1)
{code}
curl -XPOST -d 'method1=objects.create&arg1={"name":"abonent", "parent_id":1, "tarif_id":1}' http://<ip-биллинга>:8082/rest_api/v2/Abonents/ -D -
{code}
В поле pk получаем id абонента. В данном случае id 1339
2. Необходимо подождать, пока биллинг обработает запрос. В зависимости от производительности 5-10 секунд.
3. Создаем учетную запись по id абонента, указывая логин abonent1.
{code}
curl -XPOST -d 'method1=objects.create&arg1={"abonent_id":"1339", "login":"abonent1"}' http://<ip-биллинга>:8082/rest_api/v2/Users/ -D -
{code}
Пароль при этом генерирует биллинг.
# h5. Получить данные по учетным записям абонента
{code}
curl -XPOST -d 'method1=objects.filter&arg1={"abonent__pk":"1234"}' 'http://169.254.80.82:8082/rest_api/v2/Users/' -D -
{code}
# h5. Получить логин, ip адрес, название атрибута в тарифе абонента, значение атрибута в тарифе абонента по незаблокированным абонентам
{code}
curl "http://169.254.80.82:8082/rest_api/v2/Users/" -XPOST -d 'method1=objects.filter&arg1={"abonent__deleted": 0, "abonent__abonent_id_abonentsblock__isnull": 1}&fields=["ip", "login", "abonent__tarif__tarif_id_tarifradiusparams__attribute", "abonent__tarif__tarif_id_tarifradiusparams__thevalue"]'
{code}
# h5. Добавить абоненту с id 100 атрибут, который имеет id 200 со значением 300
{code}
curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AttributeValues/' --data 'method1=objects.create&arg1={"abonent_id":"100","attribute_id":"200","attribute_value":"300"}'
{code}
BASH скрипт, который добавляет физ.лицам атрибут, который имеет id 200 со значением 300
{code}
sqlexec "set list on; select id from abonents where company=0" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AttributeValues/' --data 'method1=objects.create&arg1={"abonent_id":'$line',"attribute_id":"200","attribute_value":"300"}'; done
{code}
# h5. Отправить абоненту id 1313 сообщение по шаблону с id 1 методом sms-оповещения
{code}curl -XPOST -d 'method1=objects.create&arg1={"abonent_id": "1313", "admin_msg_id": "1", "ttype_id": "1"}' 'http://169.254.80.82:8082/rest_api/v2/MsgStack/' -D -{code}
# h5. Сделать приход 10 рублей абоненту с номером договора BILL0000021
{code}curl -XPOST -d 'method1=objects.get&arg1={"contract_number": "BILL0000021"}&method2=add_payment&arg2={"SUM_IN": "10"}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -{code}
# h5. Создать абонента ФИО abonent в директории с id 1 (Все), tarif_id 1 (Основной тариф) и балансом 10р
{code}curl -XPOST -d 'method1=objects.create&arg1={"name":"abonent", "parent_id":1, "tarif_id":1}&method2=add_payment&arg2={"SUM_IN": "10"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -{code}
# h5. Ввод начальных остатков/синхронизация балансов. Установить абоненту с id 1111 баланс бухгалтерский в объёме 50.5р, комментарий к финансовой операции "Миграция балансов"
{code}curl -XPOST -d 'method1=objects.create&arg1={"abonent_id": 1111, "op_summa": "50.5", "op_type_id": 8, "descr": "Миграция балансов"}' 'http://169.254.80.82:8082/rest_api/v2/FinanceOperations/' -D -{code}
h5. Ввод начальных остатков в зависимости от номера договора. В примере указан номер договора 'test'. Номер договора обязательно должен быть экранирован кавычками ''.
{code}
sqlexec "set list on; select id from abonents where contract_number='test'" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.create&arg1={"abonent_id":'$line', "op_summa": "50.5", "op_type_id": 8, "descr": "Миграция балансов"}' 'http://169.254.80.82:8082/rest_api/v2/FinanceOperations/' -D -; done
{code}
# h5. Добавление дома в справочник "Дома". Дом будет создан с адресом г.Москва Ленина 5
{code}curl -XPOST -d 'method1=objects.create&arg1={"city":"Москва", "street":"Ленина", "s_number":'5'}' http://169.254.80.82:8082/rest_api/v2/Homes/ -D{code}
# h5. Добавления пула домов с помощью Bash скрипта. Будет создано 5 домов :1,2,3,4,5 c адресом г. Москва Ленина 1, г. Москва Ленина 2 и т.д. X - номер первого дома в пуле.
{code}X=1; while [ "$X" -lt "6" ]; do curl -XPOST -d 'method1=objects.create&arg1={"city":"Москва", "street":"Ленина", "s_number":'$X'}' http://169.254.80.82:8082/rest_api/v2/Homes/ -D -;X=$((X+1)); done{code}
# h5. Удаление всех неиспользуемых домов
{code}
sqlexec "set list; select H.id from abonents A right join homes H on A.home_id = H.id where A.home_id is null" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=delete&arg2={}' 'http://169.254.80.82:8082/rest_api/v2/Homes/' -D -; done
{code}
# h5. Получение баланса по абоненту.
{code}curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":"<ID-абонента>"}&fields=["balance"]' http://<ip-биллинга>:8082/rest_api/v2/AdminAccounts/ -D -{code}
# h5. Установка значения в поле "Порог отключения"
{code}curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":"<ID-абонента>"}&method2=set&arg2={"limit":"-5000"}&method3=save&arg3={}' http://<ip-биллинга>:8082/rest_api/v2/AdminAccounts/ -D -{code}
# h5. Установка значения в поле "Порог предупреждения" всей группе с помощью bash скрипта. В примере указана группа с id 1316 и Порог предупреждения - 12000
{code}
sqlexec "set list on; select id from abonents where parent_id=1316" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":'$line'}&method2=set&arg2={"limit_warning":"-12000"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -; done
{code}
# h5. Получить полный лог звонков абонентов за указанный период (включая обе даты)
{code}curl -XPOST -d 'method1=objects.filter&arg1={"s_time__gt":"2017-11-20", "s_time__lte":"2017-12-01"}' http://168.254.80.82:8082/rest_api/v2/VoipLog/ -D -{code}
# h5. Поменять учетной записи с id 1395 snatip на 8.8.8.8
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":'1395'}&method2=set&arg2={"snatip":"8.8.8.8"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -
{code}
# h5. Поменять всем абонентам из папки с id 1000 snat_pull на snat_pull с id 1030
{code}
sqlexec "set list on; select u.id from users u left join abonents a on a.id=u.abonent_id where a.parent_id=1000" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=set&arg2={"snat_pull":"1030"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -; done
{code}
# h5. Поменять всем учетным записям дополнительный параметр opt82 со 100 на 3100
{code}sqlexec "set list on; select id from users where opt82_param='100'" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=set&arg2={"opt82_param":"3100"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -;done{code}
# h5. Установить абоненту с номером договора BILL0000014 статус с id 26
{code}
curl -XPOST -d 'method1=objects.get&arg1={"contract_number": "BILL0000014"}&method2=set_object_status&arg2={"status_id": "26"}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -
{code}
# h5. Установить абонентам из папки с id 1354 статус с id 26
{code}
sqlexec "set list on; select id from abonents where parent_id=1354" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=set_object_status&arg2={"status_id": "26"}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done
{code}
# h5. Установить учетной записи с id 1418 nas c id 1116.
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":'1418'}&method2=set&arg2={"nas_id":"1116"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -
{code}
# h5. Установить всем учетным записям абонентов из папки 1386 nas c id 1116.
{code}
sqlexec "set list on; select id from users where abonent_id in (select id from abonents where parent_id=1386)" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=set&arg2={"nas_id":"1116"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -; done
{code}
# h5. Установить всем абонентам из папки id 1386 пул ip-адресов с id 1003 и выдать новый ip-адрес из пула
{code}sqlexec "set heading off; select u.id from users u join abonents a on u.abonent_id=a.id and a.parent_id=1386" | sed '/^$/d; s/ *//g' | while read -r userid; do curl -XPOST -d 'method1=objects.get&arg1={"id":"'$userid'"}&method2=set&arg2={"ip":"","pull":"1003"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -; done{code}
# h5. Добавить всем абонентам с блокировкой по отрицательному балансу и балансом меньше, чем '-1' приход 600 рублей
{code}sqlexec "set list on; select distinct a.id from ABONENTS A left join ADMIN_ACCOUNTS AA on AA.ID=A.ACCOUNT_ID left join abonents_block ab on ab.abonent_id=a.id where A.IS_FOLDER=0 and a.deleted=0 and ab.B_NEGBAL=1 and round((aa.ostatok+aa.debit-aa.credit) / cast((10000000000) as numeric(18,5)), 2)<-1" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=add_payment&arg2={"SUM_IN": "600"}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done{code}
# h5. Установить абоненту c id 2003 опцию "Не отключать при превышении порога"
{code}
curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":"2003"}&method2=set&arg2={"unlimited":"1"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -
{code}
# h5. Установить всем абонентам с блокировкой по отрицательному балансу и балансом больше, чем 2, опцию "Не отключать при превышении порога"
{code}
sqlexec "set list on; select distinct a.id from ABONENTS A left join USERS U on A.ID = U.ABONENT_ID left join TARIF T on A.TARIF_ID=T.ID left join ADMIN_ACCOUNTS AA on AA.ID=A.ACCOUNT_ID left join users_usluga uu on uu.ABONENT_ID=A.ID left join usluga usl on usl.id=uu.USLUGA_ID left join abonents_block ab on ab.abonent_id=a.id where A.IS_FOLDER=0 and a.deleted=0 and ab.B_NEGBAL=1 and round((aa.ostatok+aa.debit-aa.credit) / cast((10000000000) as numeric(18,5)), 2)>2" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":'$line'}&method2=set&arg2={"unlimited":"1"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -; done
{code}
# h5. Перенести всех неудаленных абонентов с тарифом, у которого id 1212 , в группу, у которой id 4911
{code}
sqlexec "set list on; select distinct id from abonents where tarif_id=1212 and is_folder=0 and deleted=0" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=move_to&arg2={"target":4911}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done
{code}
# h5. Удаление абонента с ID 1234
Удалить абонента в корзину
{code}curl -XPOST -d 'method1=objects.get&arg1={"id": "1234"}&method2=delete&arg2={}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -{code}
Удалить абонента в корзину и разорвать связть с подключенными услугами:
{code}curl -XPOST -d 'method1=objects.get&arg1={"id": "1234"}&method2=delete&arg2={"clean_links": "UsersUsluga"}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -{code}
Удалить абонента и разорвать все связи: с учетными записями, подключенными услугами и тд.
{code}curl -XPOST -d 'method1=objects.get&arg1={"id": "1234"}&method2=delete&arg2={"clean_links": true}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -{code}
# h5. Удаление всех абонентов, которые не являются папками, из папки 5293
{code}sqlexec "set list on; select id from abonents where parent_id=5293 and is_folder=0" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=delete&arg2={}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done{code}
# h5. Выставить всем абонентам из папки с id 1433 порог отключения '-5000'
{code}sqlexec "set list on; select distinct id from abonents where parent_id=1433" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":'$line'}&method2=set&arg2={"limit":"-5000"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -; done{code}
# h5. Изменить массово тариф всем абонентам с тарифа 1137 на тариф 1134
{code}sqlexec "set list on; select distinct id from abonents where tarif_id=1137" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=set&arg2={"tarif_id":"1134"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -; done{code}
# h5. Применить административную блокировку с комментарием "Блокировка" к абоненту c id 1607
{note}Если у абонента нет услуг, которые можно заблокировать - блокировка применена не будет\!{note}
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1607"}&method2=block&arg2={"comment":"Блокировка"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -
{code}
# h5. Применить административную блокировку с комментарием "Блокировка" к абонентам, у которых баланс меньше 0
{code}sqlexec "set list on; select distinct a.id from ABONENTS A left join ADMIN_ACCOUNTS AA on AA.ID=A.ACCOUNT_ID where A.IS_FOLDER=0 and a.deleted=0 and round((aa.ostatok+aa.debit-aa.credit) / cast((10000000000) as numeric(18,5)), 2)<0" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=block&arg2={"comment":"Блокировка"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -; done{code}
# h5. Убрать административную блокировку с абонента с id 1607 от имени администратора root
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":"1607"}&method2=unblock&arg2={"admin_username":"root"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -
{code}
# h5. Убрать административную блокировку с абонентов, у которых баланс больше 0 от имени администратора root.
{code}
sqlexec "set list on; select distinct a.id from ABONENTS A left join ADMIN_ACCOUNTS AA on AA.ID=A.ACCOUNT_ID where A.IS_FOLDER=0 and a.deleted=0 and round((aa.ostatok+aa.debit-aa.credit) / cast((10000000000) as numeric(18,5)), 2)>0" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=unblock&arg2={"admin_username":"root"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -; done
{code}
# h5. Получить детальную информацию по расходам абонента на интернет, телефонию и другие услуги за определённый период времени
## [Вкладка "Расход", таблица "Расход"|CarbonBilling:Счетчики услуг. Вкладка "Расход".]
{code}curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id":"1242","s_date__range":["2018-10-01", "2018-11-01"]}' http://169.254.80.82:8082/rest_api/v2/Counters/ -D -{code}
## [Детализация списаний за период|CarbonBilling:Детализация расхода]
{code}curl -XPOST -d 'method1=objects.filter&arg1={"abonent_id":"1242","change_balance_time__range":["2018-10-01", "2018-11-01"],"storno":0}' http://169.254.80.82:8082/rest_api/v2/ArchAccountStack/ -D -{code}
# h5. Применить добровольную блокировку
{code}curl -XPOST -d 'method1=objects.get&arg1={"id":"12419"}&method2=set&arg2={"own_disabled_start":"2018-10-03","own_disabled_end":"2018-11-03"}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -{code}
# h5. Подключить обещанный платеж из личного кабинета
Делается в три этапа:
## Авторизоваться, получив SUID
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=objects.get&arg1={"abonent_id":"12230"}&method2=get_or_create_dynamic_session&arg2={}'{code}
Пример ответа с SUID - 144997776676316356
{code}{"call": "/rest_api/v2/Users/", "result": {"pk": null, "model": "DynamicSessions", "fields": {"ttype": "None", "id": 12200, "suid": "144997776676316356"}}}{code}
## Использовать SUID чтобы получить список обещанных платежей доступных абоненту для подключения из личного кабинета
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=web_cabinet.get_promise_pay_list&arg1={"suid":"144997776676316356"}'{code}
## Подключить обещанный платеж
{code}curl -XPOST -d 'method1=objects.create&arg1={"abonent_id":12420,"usluga_id":240,"manager_id": 33}' http://169.254.80.82:8082/rest_api/v2/UsersUsluga/ -D -{code}
*manager_id* - это ID администраторов, получить их список можно так:
{code}curl -XPOST -d 'method1=objects.filter' http://169.254.80.82:8082/rest_api/v2/DjangoUsersProfile/ -D -{code}
# h5. Получить список услуг доступных абоненту для подключения в личном кабинете
Делается в три этапа:
## Авторизоваться, получив ID авторизации
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=objects.get&arg1={"abonent_id":"12230"}&method2=get_or_create_dynamic_session&arg2={}'{code}
{note}*Работает только если у абонента одна учетная запись!* Если больше одной - используйте ID учетной записи: {code}method1=objects.get&arg1={"id":"12345"}{code}{note}
## Получить список всех доступных для подключения и подключенных услуг
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=web_cabinet.get_usluga_list&arg1={"suid":"144997776676316356","get_user_uslugas_all":1}'{code}
## Список всех подключенных услуг
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=web_cabinet.get_usluga_list&arg1={"suid":"144997776676316356","get_setted":1}'{code}
Отфильтровать услуги определенного типа можно подобавив в запрос на втором или третьем шаге параметр system_type_id:
{code}0 Стандартный
1 Турбокнопка
3 Бонусный трафик
4 Форсаж
2 Подписка
6 Пакет МБ
5 IP телефония
7 IP телевидение
8 Абонентская плата
9 Трафик
10 Скидка\Наценка
11 Обещанный платеж
12 Пакет услуг
13 Системный {code}
# h5. Сторнирование услуг
В примере: массовое сторнирование по всем неудаленным абонентам за период с 1 января 2017 по 1 января 2018 года
{code}sqlexec "set heading off; select id from abonents where is_folder=0 and deleted=0" | sed '/^$/d' | sed 's/ *//g' | while read -r abonid; do curl -XPOST -d 'method1=objects.get&arg1={"id":"'$abonid'"}&method2=storno_credit&arg2={"sdate":"2017-01-01", "edate":"2018-01-01"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -; done {code}
# h5. Удаление услуг
В примере: массовое удаление [автоматический подключенных обещанных платежей по льготному периоду|CarbonBilling:Льготный период оплаты]
{code}sqlexec "set heading off; select id from users_usluga where comment like 'Автоматический%предоплате%2017-12-31%'" | sed '/^$/d' | sed 's/ *//g' | while read -r uusligaid; do echo "$uusligaid"; curl -XPOST -d 'method1=objects.get&arg1={"id":"$uusligaid"}&method2=delete' http://169.254.80.82:8082/rest_api/v2/UsersUsluga/ -D -; done{code}
# h5. Смена пароля учетной записи
h6. Установить определенный пароль:
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Users/' -d 'method1=objects.get&arg1={"id":4084}&method2=set_password&arg2={"psw":"1234","dontshow":false}'{code}
*psw* - новый пароль
*dontshow* - +false+ чтобы пароль сохранился в открытом виде и отображался в администраторской панели, +true+ - чтобы не отображался.
h6. Сгенерировать случайный пароль:
Сделайте два запроса: первым уберите пароль абонента, вторым инициируйте сохранение учетной записи:
{code}
curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Users/' -d 'method1=objects.get&arg1={"id":4084}&method2=set_password&arg2={"psw":""}
curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Users/' -d 'method1=objects.get&arg1={"id":4084}&method3=save&arg2={}
{code}
h6. Установить пароль через форму восстановления пароля:
Отправляем по API запрос на восстановление reset_password, параметры login (login или email), base_url.
{code}
curl -XPOST "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=web_cabinet.reset_password&arg1={"login":"user297", "base_url":""}'
{code}
Получаем в ответ uid = user_id
Клиент получает поле с кодом *token* на почту или через смс.
Отправляем проверочный код и новый пароль по API submit_password, параметры token (код из смс, в верхнем регистре), uid (из ответа reset_password или user_id), psw1 и psw2 (одинаковые пароли длиннее 6 символов)
{code}
curl -XPOST "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=web_cabinet.submit_password&arg1={"token":"475GZ4", "uid":"297", "psw1":"123456", "psw2":"123456"}'
{code}
# h5. Всем абонентам из папки 14724, у которых выставлена опция "Не отключать при превышении порога" отключить опцию "Не отключать при превышении порога"
{code}
sqlexec "set list on; select distinct a.id from ABONENTS A left join USERS U on A.ID = U.ABONENT_ID left join TARIF T on A.TARIF_ID=T.ID left join ADMIN_ACCOUNTS AA on AA.ID=A.ACCOUNT_ID left join users_usluga uu on uu.ABONENT_ID=A.ID left join usluga usl on usl.id=uu.USLUGA_ID left join abonents_block ab on ab.abonent_id=a.id where A.IS_FOLDER=0 and a.deleted=0 and aa.unlimited=1 and a.parent_id=14724" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":'$line'}&method2=set&arg2={"unlimited":false}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -; done
{code}
# h5. Скрипт для создания абонента и учетной записи. Создаёт абонента в папке "Все" с именем "ФИО1", номером договора TEST_API1, тарифом с id=1, балансом 10, логином abonent2, паролем 1234
{code}
#!/bin/bash

curl -XPOST -d 'method1=objects.create&arg1={"name":"ФИО1", "parent_id":1, "tarif_id":1, "contract_number":"TEST_API1"}&method2=add_payment&arg2={"SUM_IN": "10"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -

sqlexec "set list on; select id from abonents where contract_number='TEST_API1'" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.create&arg1={"abonent_id":'$line', "login":"abonent2"}&method2=set_password&arg2={"psw":"1234","dontshow":false}' http://169.254.80.82:8082/rest_api/v2/Users/ -D -; done
{code}
# h5. Сменить абонентам с оператором связи ID 3 оператора связи с ID 1444
{code}sqlexec "set list; select id from abonents where operator_id=3 and id>3" | awk '$2{print $2}' | while read abon; do curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -d 'method1=objects.get&arg1={"id":'$abon'}&method2=set&arg2={"operator_id":1444}&method3=save&arg3={}'; done{code}
# h5. Получить данные учетной записи абонента, авторизованного в личном кабинете, по идентификатору сессии suid
{code}curl "http://169.254.80.82:8082/rest_api/v2/Users/" -d 'method1=get_user_by_suid&arg1={"suid": "144997776676316356"}'{code}
# h5. Список абонентов блокировкой negbal, выводим логин и IP адерес.
{code}curl -XPOST -d 'method1=objects.filter&arg1={"abonent__deleted": 0, "abonent__abonent_id_abonentsblock__b_negbal": 1 }&method2=distinct&fields=["login", "ip"]' "http://169.254.80.82:8082/rest_api/v2/Users/" -D -{code}
# h5. Рассылка сообщения по населенному пункту.
{code}sqlexec "set heading off; select id from abonents where home_id in (select id from homes where CITY='Тихорецк') and deleted=0 and is_folder=0"| sed '/^$/d' | sed 's/ *//g' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id": '$line'}&method2=send_message&arg2={"tmpl_id": "6", "send_date": "2019-04-08 12:30:00" }' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done{code}
# h5. Работа с реквизитами
Добавить абоненту с ID 1376 реквизит с ID 33 и значением "Тест"
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AttributeValues/' -d 'method1=objects.create&arg1={"attribute_id":33,"abonent_id":1376,"attribute_value":"Тест"}'{code}
Удалить реквизит с ID 1684
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AttributeValues/' -d 'method1=objects.get&arg1={"id":1684}&method2=delete'{code}
# h5. Получить список абонентов со статусом "заблокирован или нет" (наличие блокировок в AbonentsBlock), поля: ID, Наименование/ФИО, статус
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -d 'method1=objects.filter&arg1={"is_folder":0}&fields=["id","name","allow_internet"]'{code}
# h5. Работа с блокировками абонентов и их историей
Получить ID текущих блокировок по балансу абонента с ID 1392
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AbonentsBlock/' -d 'method1=objects.filter&arg1={"abonent_id":1392,"b_negbal":1}&fields=["id"]'{code}
Снять блокировку с ID 243068
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AbonentsBlock/' -d 'method1=objects.get&arg1={"id":243068}&method2=delete'{code}
Получить ID блокировок абонента ID 1392 измененных с 1 по 30 июня 2019 года
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AbonentsBlockHistory/' -d 'method1=objects.filter&arg1={"abonent_id":1392,"b_negbal":1,"time_changed__range":["2019-06-01", "2019-06-30"]}&fields=["id"]'{code}
Получить ID блокировок абонента ID 1392 снятых с 1 по 30 июня 2019 года
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AbonentsBlockHistory/' -d 'method1=objects.filter&arg1={"abonent_id":1392,"b_negbal":1,"time_del__range":["2019-06-01", "2019-06-30"]}&fields=["id"]'{code}
Изменить запись в истории блокировок ID 118, установить время изменения и снятия на 1 июня 2019 года
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/AbonentsBlockHistory/' -d 'method1=objects.get&arg1={"id":118}&method2=set&arg2={"time_changed":"2019-06-01 00:00:00","time_del":"2019-06-01 00:00:00"}&method3=save'{code}
# h5. Перерасчетать абонента начиная с выбранного периода (обязательно указывать первое число месяца!)
Перерасчет абонента с ID 1392 с июня 2019 года
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -d 'method1=objects.get&arg1={"id":"1392"}&method2=set&arg2={"need_recalc":"2019-06-01"}&method3=save&arg3={}'{code}
# h5. Получение данных о счете абонента
1) Выведем общую сумму к оплате, дату выставления,номер счёта и период, также в запросе мы увидим pk (это id счёта, у нас он - 13707416)
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/FinanceOperations/' -d 'method1=objects.filter&arg1={"abonent_id":6019,"op_type":5}&fields=["op_summa", "op_date", "number", "period_end_date"]'{code}
2) Подставляем айди полученного счёта (pk из предыдущего запроса подставляем как finance_operation_id), увидим список услуг, количество единиц, названия и суммы.
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/FinanceOperationsDetail/' -d 'method1=objects.filter&arg1={"finance_operation_id":13707416}&fields=["usluga", "unit", "vv", "price", "name"]'{code}
# h5. Получение данных об операторе, обслуживающем абонента
{code}curl -XPOST 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -d 'method1=objects.filter&arg1={"id":1111}&fields=["operator"]'{code}
# h5. Установка порога отключения на сумма тарифа + 1 всем абонентам из папки.
{code}sqlexec "set heading off; select distinct a.id ||' ' || (round(u.SUMMA / cast((select CONST_VALUE from VPN_CONST where CONST_ID = 1) as numeric(18,5)), 2)+1 ) from abon LEFT JOIN TARIF_USERS_USLUGA tus ON tus.TARIF_ID=t.ID LEFT JOIN USLUGA u ON u.ID=tus.USLUGA_ID where a.parent_id=89" | while read -r a b; do curl -XPOST -d 'method1=objects.get&arg1={"account_id_abonents":'$a'}&method2=set&arg2={"limit":'$b'}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/AdminAccounts/ -D -; done
{code}
# h5. Вывести данные по абоненту, у которого номер SMS для оповещений +71234567899
{code}
curl -XPOST -d 'method1=objects.filter&arg1={"sms":"'%2B'71234567899"}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -
{code}
# h5. Удаление учетной записи.
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":6242}&method2=delete&arg2={"clean_links": true}'' http://169.254.80.82:8082/rest_api/v2/Users/ -D -
{code}
Аргумент "clean_links" обязателен.
# h5. Установить абонентам в папке с ID 1405 галочку "Юр. лицо"
{code}
sqlexec "set list on; select id from abonents where parent_id=1405" | awk ' {print $2} ' | sed '/^$/d' | while read line; do curl -XPOST -d 'method1=objects.get&arg1={"id":'$line'}&method2=set&arg2={"company":"1"}&method3=save&arg3={}' 'http://169.254.80.82:8082/rest_api/v2/Abonents/' -D -; done
{code}
# h5. Снять абонентам в папке с ID 1405 галочку "Юр. лицо"
{code}

{code}
Если нужно убавить бонусные баллы, то введите отрицательное значение:
{code}
curl -XPOST -d 'method1=objects.create&arg1={"bonus_score":-1000,"abonent_id":2566,"account_id":10002566}' http://169.254.80.82:8082/rest_api/v2/AccountStack/ -D -
{code}
Чтобы обновить информацию об абоненте в веб-интерфейсе обновим кэш:
{code}
curl -XPOST -d 'method1=objects.get&arg1={"id":2566}&method2=set&arg2={"need_refresh_cache":1}&method3=save&arg3={}' http://169.254.80.82:8082/rest_api/v2/Abonents/ -D -
{code}

h2. Отладка
API-запросы и ошибки их выполнения логируются в следующие файлы:
{code}/app/asr_billing/var/log/django/error.log
/app/asr_billing/var/log/django/api_v2.log{code}
По-умолчанию, уровень логирования установлен в *error*. Для того, чтобы логировать все запросы, установите в конфигурационном файле */app/asr_billing/cfg/config* уровень логирования *django* в *info*:
* Откройте конфигурационный файл биллинга в любом удобном текстовом редакторе, например _vim_:
{code}vim /app/asr_billing/cfg/config{code}
* Найдите в файле опцию *app\['django.loglevel'\]=* и установите её в значение *info*:
{code}app['django.loglevel']='info'{code}
* Перезапустите web-сервер биллинга:
{code}chroot /app/asr_billing/ service admin_web_server restart{code}
По окончанию отладки, рекомендуется вернуть уровень логирования в статус \*error