Ako pracovať s rozhraním BILLmanager API

API je softvérové rozhranie, ktoré umožňuje ovládať akúkoľvek aplikáciu prostredníctvom súboru príkazov a funkcií. Existuje napríklad rozhranie API služby Yandex Music, vďaka ktorému môžete počúvať hudobné skladby na stránke. V našej práci používame fakturačný systém BILLmanager.

Má vlastné rozhranie API, pomocou ktorého môžete škálovať servery pri flexibilných tarifách, získavať informácie o platbách a inkasách z účtu. Každý vývojár API má spravidla na svojej webovej stránke podrobnú dokumentáciu o tom, ako nainštalovať a nakonfigurovať softvérové rozhranie.

Dokumentáciu API aplikácie BILLmanager je však ťažké zvládnuť. Ak sa chcete stať profesionálom v práci s rozhraním API, je načase začať študovať dokumentáciu. Ak je pre vás hlavné dokončiť úlohu a získať výsledok v krátkom čase, stačí použiť nižšie uvedené pokyny.

Zoznam parametrov

Jednou z prvých otázok, ktoré sa vynárajú pri práci s rozhraním API BILLmanager, je, kde získať zoznam parametrov? Všetky parametre pre prácu s aplikáciou BILLmanager nájdete v dokumentácii od vývojára. Úplný zoznam pracovných parametrov nájdete na tomto odkaze.

Ako získať zoznam VDS

Ak chcete získať zoznam VDS, musíte vykonať požiadavku na nasledujúcu adresu URL:

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

Parametre v požiadavke:

• authinfo - údaje o autorizácii vo fakturácii;
• func - funkcia vykonaná vo fakturácii;
• out - výstupný formát údajov, podporované sú formáty xml, json a JSONdata.

Vo všetkých požiadavkách musíte použiť svoje osobné údaje, preto zmeňte username:password na svoje prihlasovacie meno a heslo a potom vykonajte požiadavku GET, napríklad pomocou CURL.

Ako objednať VDS

Ak chcete objednať VDS, musíte vykonať požiadavku na nasledujúcu adresu 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

Parametre v požiadavke:

• authinfo - autorizačné údaje vo fakturácii;
• func - funkcia vykonávaná vo fakturácii;
• addon_X - doplnok na objednanie (nepovinný), napríklad na objednanie ústredne alebo adries IPv6;
• autoprolong - možnosť povoliť alebo zakázať automatické obnovenie servera;
• ostempl - šablóna OS pre objednávku;
• period - obdobie objednávky, uvádza sa počet mesiacov, podporované sú 1, 3, 6, 12;
• pricelist - ID tarifného plánu;
• skipbasket - príznak pre preskočenie fázy umiestnenia nákupného košíka, pre automatické objednanie služby;
• domain - názovdomény servera (nepovinné);
• sok - potvrdenie požiadavky.

Zmena parametrov servera

API na zmenu parametrov virtuálneho servera:

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

Na zmenu parametrov vyhradeného servera:

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

Parametre v požiadavke:

• authinfo - autorizačné údaje vo fakturácii;
• func - funkcia vykonávaná vo fakturácii;
• elid - kód služby;
• addon_X - doplnok, ktorý sa má zmeniť (nepovinné), napríklad zmeniť počet IP adries;
• domain - názov domény (nepovinné);
• sok - potvrdenie žiadosti.

Dodatky k tarifnému plánu pri objednávaní alebo zmene služby prostredníctvom API sa odovzdávajú prostredníctvom parametra addon_, ktorý nadobúda hodnotu addon_5=10, kde 5 je kód dodatku, 10 je hodnota.

Pri zadávaní požiadaviek API môžete použiť konzolu prehliadača, na karte "sieť" môžete vidieť, aké požiadavky sa zadávajú z prehliadača pri objednávaní servera, rovnaké parametre sa môžu odovzdávať prostredníctvom požiadaviek API. Uvedený zoznam opisuje príklady požiadaviek API s neúplným zoznamom funkcií a parametrov.

Práca s cyklami

Ak potrebujete odstrániť VDS, pridať pamäť alebo procesorové jadrá, môžete to urobiť bez použitia rozhrania API aplikácie BILLmanager. V prípade objednania 10, 100 VDS alebo hromadnej zmeny parametrov servera však tento proces môže trvať niekoľko hodín. V takýchto prípadoch je zvykom používať cykly:

#!/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

V príklade je použitá požiadavka na objednanie servera cez API, v sekvencii je uvedený počet serverov, ktoré sa majú objednať. Parametre objednávania serverov sú podobné ako pri objednávaní jedného servera bez použitia cyklov.

Úplná dokumentácia o práci s rozhraním API BILLmanager od vývojára je k dispozícii tu.