Как да работите с API на BILLmanager

API е софтуерен интерфейс, който ви позволява да управлявате всяко приложение чрез набор от команди и функции. Например, съществува API на Yandex Music, благодарение на който можете да слушате музикални песни в сайта. В нашата работа използваме системата за таксуване BILLmanager.

Тя има собствен API, с помощта на който можете да мащабирате сървъри при гъвкави тарифи, да получавате информация за плащанията и дебитирането на сметките. По правило всеки разработчик на API има подробна документация на своя уебсайт за това как да инсталирате и конфигурирате софтуерния интерфейс.

Документацията за API на BILLmanager обаче е трудна за овладяване. Ако искате да станете професионалист в работата с API, тогава е време да започнете да изучавате документацията. Ако основното за вас е да изпълните задачата и да получите резултата за кратък период от време, достатъчно е да използвате инструкциите по-долу.

Списък на параметрите

Един от първите въпроси, които възникват при работа с API на BILLmanager, е откъде да получите списъка с параметрите? Всички параметри за работа с BILLmanager можете да намерите в документацията от разработчика. Пълният списък на параметрите за работа можете да намерите, като последвате тази връзка.

Как да получите списък на VDS

За да получите списък на VDS, трябва да направите заявка към следния URL адрес:

https://bill.pq.hosting/billmgr?func=vds&authinfo=username:password&out=JSONdata

Параметри в заявката:

• authinfo - данни за оторизация при фактуриране;
• func - функция, изпълнена във фактурата;
• out - формат за извеждане на данните, поддържат се xml, json и JSONdata.

Във всички заявки трябва да използвате личните си данни, затова променете username:password на вашето потребителско име и парола, след което направете заявка GET, например с помощта на CURL.

Как да поръчате VDS

За да поръчате VDS, трябва да направите заявка към следния URL адрес:

https://bill.pq.hosting/billmgr?func=vds.order.param&authinfo=username:password&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

Параметри в заявката:

• authinfo - данни за оторизация при фактуриране;
• func - функция, изпълнена във фактурата;
• addon_X - добавка за поръчка (по избор), например за поръчка на контролен панел или IPv6 адреси;
• autoprolong - опция за включване или изключване на автоматичното подновяване на сървъра;
• ostempl - шаблон на операционната система за поръчката;
• period - период на поръчката, посочва се броят на месеците, поддържат се 1, 3, 6, 12;
• pricelist - идентификатор на тарифния план;
• skipbasket - флаг за прескачане на етапа на поставяне на кошница за пазаруване, за автоматична поръчка на услугата;
• domain - име надомейна на сървъра (по избор);
• sok - потвърждение на заявката.

Промяна на параметрите на сървъра

API за промяна на параметрите на виртуалния сървър:

https://bill.pq.hosting/billmgr?func=vds.edit&authinfo=username:password&addon_11=512&elid=958&domain=company.com&sok=ok

За промяна на параметрите на специален сървър:

https://bill.pq.hosting/billmgr?func=dedic.edit&authinfo=username:password&addon_26=10&addon_26=10&addon_28=5000&elid=1065&sok=ok

Параметри в заявката:

• authinfo - данни за оторизация при фактуриране;
• func - функция, изпълнена в сметката;
• elid - код на услугата;
• addon_X - добавка за промяна (по избор), например за промяна на броя на IP адресите;
• domain - име на домейн (по избор);
• sok - потвърждение на заявката.

Добавките към тарифния план при поръчка или промяна на услуга чрез API се предават чрез параметъра addon_, който приема стойността addon_5=10, където 5 е кодът на добавката, а 10 е стойността.

При извършване на заявки към API можете да използвате конзолата на браузъра, в раздела "мрежа" можете да видите какви заявки се извършват от браузъра при поръчка на сървър, същите параметри могат да се предават чрез заявки към API. Списъкът по-горе описва примери за API заявки, като списъкът с функции и параметри е непълен.

Работа с цикли

Ако трябва да премахнете VDS, да добавите памет или процесорни ядра, можете да го направите без API на BILLmanager. Въпреки това, в случай на поръчка на 10, 100 VDS или масова промяна на параметрите на сървъра, този процес може да отнеме няколко часа. За такива случаи е обичайно да се използват цикли:

#!/bin/bash
seq 1 32 | while read line; do
  curl -s -k "https://bill.pq.hosting/billmgr?func=vds.order.param&authinfo=username:password&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$line&sok=ok"
done

В примера се използва API заявка за поръчка на сървъри, като seq указва броя на сървърите, които трябва да се поръчат. Параметрите за поръчка на сървър са подобни на тези за поръчка на единичен сървър, без да се използват цикли.

Пълната документация за работа с API на BILLmanager от разработчика е налична тук.