API REST SOAP

Api работает через порт 8082.

В api можно получить подробные сведения о каждой модели веб-интерфейса администратора Carbon Billing 5.

• поля модели;
• методы модели;
• методы объекта.
  

Создадим тариф с помощью api. Обязательно указываем аргумент, даже если он пустой.

Возвращается XML документ с подробными описаниями для нового объекта.

Можно задать сразу имя тарифа:

В файле можно увидеть, что тариф создался с именем:

Также мы можем получить файл не в XML виде, а в json, для этого пишем в командной строке: 

После создания или изменения объекта, его нужно сохранить:

Логика биллинга отработает и вернет значения, которые после сохранения выставились в тарифе.
Теперь этот тариф можно увидеть в веб-интерфейсе администратора Carbon Billing 5.

Чтобы авторизоваться для работы в api, необходимо зайти в веб-интерфейс администратора Carbon Billing 5, раздел Настройки/Настройки (в файле)/Настройка Сети.

Также нужно указать hash_key, который обычно известен при авторизации.

Тогда все запросы будут считаться авторизованными.

Задача: Требуется создавать абонентов с реквизитами.

1.Необходимо узнать имена моделей для составления к ним запросов, для этого заходим в администраторскую панель и нажимаем на соответствующие пункты, чтобы в строке url браузера увидеть название модели.

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

2.Также необходимо узнать ид реквизитов который хотим добавлять абоненту.

Например мы хотим добавить прописку: 15
3.Создадим группу или используем существующую для новых абонентов и узнаем ее номер для запросов:

Например 90
4.Итак узнав имена моделей (Abonents и AttributeValues), для создания запросов необходимо узнать имена полей который мы хотим заполнять, для этого делаем запросы

http://195.64.222.86:8082/rest_api/?model=Abonents

http://195.64.222.86:8082/rest_api/?model=Abonents

и

http://195.64.222.86:8082/rest_api/?model=AttributeValues

http://195.64.222.86:8082/rest_api/?model=AttributeValues

http://195.64.222.86:8082/rest_api/?model=AttributeValues соответственно.
5.Имея всю необходимую информацию по абонентам и их реквизитам сначала создаем запрос на создание абонента:

http://195.64.222.86:8082/rest_api/?model=Abonents&method1=new&arg1={"name":"Тест","parent_id":90}&method2=save&arg2={}&format=json

, в ответ мы получим json массив откуда узнаем pk созданного абонента и по нему формируем запрос на создание реквизитов указывая его каждый раз как abonent_id:

http://195.64.222.86:8082/rest_api/?model=AttributeValues&method1=new&arg1={"abonent_id":pk,"attribute_id":15,"attribute_value":"Россия"}&method2=save&arg2={}&format=json

6.Мы успешно создали абонента с именем Тест в группе VIP с реквизитом Прописка:Россия