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

Материал из ISPWiki
Перейти к: навигация, поиск

Текущая страница документации описывает как через API заказывать, удалять, продлять и изменять параметры основных услуг: виртуальный хостинг, виртуальный сервер, выделенный сервер.

Заказ услуг

API функции:

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

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

  • authinfo или auth - данные авторизации в панели управления;
  • pricelist - код тарифного плана;
  • datacenter - код Дата Центра;
  • period - период заказа. В качестве значения может быть целое число, равное количеству месяцев. Например, при заказе услуги на 1 месяц period=1, на пол года period=6, на год period=12 и т.д;
  • sok - сообщает о том, что заказ подтвержден.

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

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

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

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

https://<адрес BILLmamager>?authinfo=username:password&func=vhost.order.param&autoprolong=1&datacenter=1&domain=domain.name&period=1&pricelist=2&skipbasket=on&addon_5=10&sok=ok

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

https://<адрес BILLmamager>?authinfo=username:password&func=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&period=1&pricelist=6&skipbasket=on&domain=vds.test&sok=ok 

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

https://<адрес BILLmamager>?authinfo=username:password&func=dedic.order.param&period=1&pricelist=32&datacenter=1&domain=domain.name&addon_33=1&addon_35=1&sok=ok

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

Функция продления услуги:

  • service.prolong

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

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

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

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

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

  https://<адрес BILLmamager>?authinfo=username:password&func=service.prolong&period=1&elid=958&skipbasket=on&sok=ok

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

API функции:

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

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

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

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

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

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

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

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

 https://<адрес BILLmamager>?authinfo=username:password&func=vhost.edit&addon_34=1024&elid=945&sok=ok

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

https://<адрес BILLmamager>?authinfo=username:password&func=vds.edit&addon_11=512&elid=958&sok=ok

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

https://<адрес BILLmamager>?authinfo=admin:password&func=vds.edit&username=user134&userpassword=jYh4nsqe&domain=company.com&ip=8.8.8.8&elid=958&sok=ok

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

 https://<адрес BILLmamager>?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 - подтверждение операции.

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

 https://<адрес BILLmamager>?authinfo=username:password&func=vds.delete&elid=938&sok=ok

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

 https://<адрес BILLmamager>?authinfo=username:password&func=vhost.delete&elid=1085&sok=ok

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

  https://<адрес BILLmamager>?authinfo=username:password&func=dedic.delete&elid=892&sok=ok