Управление услугами по API

Заказ услуг

v2.{ITEMTYPE}.order.param — функция заказа

где {ITEMTYPE} — внутреннее имя типа продукта

API функции:

v2.vhost.order.param — заказ виртуального хостинга;
v2.vds.order.param — заказ виртуального сервера;
v2.dedic.order.param — заказ выделенного сервера.

Обязательные параметры:

authinfo или auth — данные авторизации в панели управления;
pricelist — код тарифного плана;
datacenter — код Дата Центра;
order_period — период заказа. В качестве значения может быть целое число, равное количеству месяцев.
Принимает одно из следующих значений:
- 1 — месяц
- 3 — 3 месяца
- 6 — 6 месяцев
- 12 — год
- 24 — 2 года
- 36 — 3 года
sok=ok — сообщает о том, что заказ подтвержден.

Дополнительные параметры:

domain — доменное имя услуги. Если параметр не задан, BILLmanager подставит произвольное значение;
skipbasket — если передать параметр skipbasket=on, то услуга не будет добавлена в корзину, а средства за нее сразу спишутся с лицевого счета;
autoprolong — период автопродления. В качестве значения может быть целое число, равное количеству месяцев;
ostempl — шаблон операционной системы для выделенного или виртуального сервера;
recipe — рецепт, который будет применен после установки ОС на виртуальном или выделенном сервере;
remoteid — уникальный идентификатор услуги на стороне перепродающей биллинговой платформы.

Дополнения тарифного плана при заказе по API передаются через параметр addon_, который принимает значение addon_5=10, где 5 — код дополнения, 10 — значение. Код дополнения можно увидеть в разделе Тарифные планы → Содержание, поле Id. Включить отображение поля возможно в настройках вида таблицы.

Пример API вызова для заказа виртуального хостинга:

https://billdomain.com?authinfo=username:password&func=v2.vhost.order.param&autoprolong=1&datacenter=1&domain=domain.name&order_period=1&pricelist=2&skipbasket=on&addon_5=10&sok=ok

Пример API вызова для заказа виртуального сервера:

https://billdomain.com?authinfo=username:password&func=v2.vds.order.param&addon_10=6&addon_11=256&addon_12=500&addon_13=1&addon_14=28&addon_15=0&addon_28=1&addon_7=5000&addon_9=5&autoprolong=1&ostempl=ISPsystem%5F%5FCentOS%2D7%2Damd64&order_period=1&pricelist=6&skipbasket=on&domain=vds.test&sok=ok

Пример API вызова для заказа выделенного сервера:

https://billdomain.com?authinfo=username:password&func=v2.dedic.order.param&order_period=1&pricelist=32&datacenter=1&domain=domain.name&addon_33=1&addon_35=1&sok=ok

Вывести список услуг клиента

Список активных услуг

API функции:

vds — виртуальный сервер;
dedic — выделенный сервер;
vhost — виртуальный хостинг;
soft — лицензии;
platform — платформа и т.д.

Параметры:

filter=on — установка фильтра по указанным параметрам
out=<формат> — формат вывода
status=2 — вывод только активных услуг
account — наименование клиента. Необходимо добавить весь текст из поля Наименование. Запрос не будет работать корректно, если данные не соответствуют указанным в поле. Например, значение account=Пример Примерович (example@example.ru).

Информация об активных услугах по типу продукта для выбранного клиента.

Пример API вызова для отображения активных выделенных серверов клиента

https://billdomain.com/billmgr?func=dedic&filter=on&account=<name>&out=json&status=2

Параметры

Список услуг по типу продукта

API функция:

vds — виртуальный сервер;
dedic — выделенный сервер;
vhost — виртуальный хостинг;
soft — лицензии;
platform — платформа и т.д.

Параметры:

out=<формат> — формат вывода

Информация об услугах по типу продукта для выбранного клиента.

https://billdomain.com/billmgr?func=dedic&clickstat=yes&out=xml

Продление услуг

Функция: service.prolong

Обязательные параметры:

authinfo или auth — данные авторизации в панели управления;
elid — код услуги;
period — период заказа. В качестве значения может быть целое число, равное количеству месяцев. Например, при заказе услуги на 1 месяц period=1, на пол года period=6, на год period=12 и т.д;
sok=ok — подтверждение операции.

Необязательные параметры:

skipbasket — если передать параметр skipbasket=on, то продление услуги не будет добавлено в корзину, а средства за нее сразу спишутся с лицевого счета.

Пример API вызова продления услуги:

https://billdomain.com?authinfo=username:password&func=service.prolong&period=1&elid=958&skipbasket=on&sok=ok

Автопродление услуг

API функции:

vds.edit — изменение параметров виртуального сервера;
dedic.edit — изменение параметров выделенного сервера;
vhost.edit — изменение параметров виртуального хостинга;
soft.edit — изменение параметров лицензии;
platform.edit — изменение параметров платформы и т.д.

Параметры:

autoprolong — параметр для автопродления, укажите период;
elid — уникальный идентификатор (id услуги).

За автопродлнение отвечает параметр autoprolong.

Его возможные значения:

autoprolong=X — при заказе лицензии будет выставлено автопродление на X месяцев;
autoprolong=12 — автопродление на год;
autoprolong=null — без автопродления.

Для каждого типа продукта используется своя функция. В примере задано автопродление на месяц для типа продукта Лицензии (функция soft.edit). Для автопродления других типов продуктов необходимо используйте соответствующую функцию:

Пример запроса для автопродления услуги на месяц

https://billdomain.com/billmgr?func=soft.edit&autoprolong=1&elid=777&sok=ok

Изменение параметров услуги

API функции:

vhost.edit — изменение параметров виртуального хостинга;
vds.edit — изменение параметров виртуального сервера;
dedic.edit — изменение параметров выделенного сервера.

Обязательные параметры:

authinfo или auth — данные авторизации в панели управления;
elid — код услуги;
sok=ok — подтверждение операции.

Необязательные параметры:

addon_ — дополнение тарифного плана, которое необходимо изменить, пример: addon_11=512, где 11 — код дополнения, 512 — значение. Код дополнения можно увидеть в разделе Тарифные планы-> Содержание, поле Id. Включить отображение поля возможно в настройках вида таблицы;
autoprolong — период автопродления. В качестве значения может быть целое число, равное количеству месяцев;
skipbasket — если передать параметр skipbasket=on, то дополнение не будет добавлено в корзину, а средства за него сразу спишутся с лицевого счета.

При авторизации от уровня администратора для изменения доступно больше параметров:

domain — доменное имя услуги;
ip — IP-адрес услуги;
username — имя пользователя в панели управления (например, в VMmanager);
userpassword — пароль пользователя в панели управления (например, в VMmanager);
serverid — наименование сервера в панели управления (например, в VMmanager);
ostempl — шаблон операционной системы для виртуального или выделенного сервера;
recipe — предустановленное ПО (рецепт) для виртуального или выделенного сервера;

Пример API вызова для изменения параметров виртуального хостинга:

https://billdomain.com?authinfo=username:password&func=vhost.edit&addon_34=1024&elid=945&skipbasket=on&sok=ok

Пример API вызова для изменения параметров виртуального сервера:

https://billdomain.com?authinfo=username:password&func=vds.edit&addon_11=512&elid=958&sok=ok

Пример API вызова для изменения доменного имени, IP-адреса и данных авторизации в панели управления для услуги виртуального сервера:

https://billdomain.com?authinfo=admin:password&func=vds.edit&username=user134&userpassword=jYh4nsqe&domain=company.com&ip=8.8.8.8&elid=958&sok=ok

Пример API вызова для изменения параметров выделенного сервера:

https://billdomain.com?authinfo=username:password&func=dedic.edit&addon_26=10&addon_26=10&addon_28=5000&elid=1065&sok=ok

Удаление услуг

API функции:

vhost.delete — удаление виртуального хостинга;
vds.delete — удаление виртуального сервера;
dedic.delete — удаление выделенного сервера.

Обязательные параметры:

authinfo или auth — данные авторизации в панели управления;
elid — код услуги;
sok=ok — подтверждение операции.

Пример API вызова для удаления виртуального сервера:

https://billdomain.com?authinfo=username:password&func=vds.delete&elid=938&sok=ok

Пример API вызова для удаления виртуального хостинга:

https://billdomain.com?authinfo=username:password&func=vhost.delete&elid=1085&sok=ok

Пример API вызова для удаления выделенного сервера:

https://billdomain.com?authinfo=username:password&func=dedic.delete&elid=892&sok=ok

Создание расходов по статистике

service.statdaily — функция отвечает за создание расходов по статистике в соответствии с настройками тарифа.

Параметры:

item — ID услуги в BILLmanager
statdate — дата, за которую произвести расчёт. Формат yyyy-mm-dd
force — укажите значение on, чтобы создать расход, если за указанную дату расчёт уже был произведён. Если расчёт за указанную дату уже был произведён, отправка запроса без параметра force=on вернёт ошибку

Пример

/usr/local/mgr5/sbin/mgrctl -m billmgr service.statdaily item=5 statdate=2023-12-31 force=on