Jak pracovat s rozhraním BILLmanager API

API je softwarové rozhraní, které umožňuje ovládat libovolnou aplikaci pomocí sady příkazů a funkcí. Existuje například rozhraní API služby Yandex Music, díky kterému můžete na webu poslouchat hudební skladby. V naší práci používáme fakturační systém BILLmanager.

Má vlastní rozhraní API, s jehož pomocí můžete škálovat servery s flexibilními tarify, získávat informace o platbách a strženích z účtu. Každý tvůrce rozhraní API má zpravidla na svých webových stránkách podrobnou dokumentaci k instalaci a konfiguraci softwarového rozhraní.

Dokumentaci API aplikace BILLmanager je však obtížné zvládnout. Pokud se chcete stát profesionálem v práci s rozhraním API, je na čase začít dokumentaci studovat. Pokud je pro vás hlavní splnit úkol a získat výsledek v krátkém čase, stačí použít níže uvedené pokyny.

Seznam parametrů

Jednou z prvních otázek, které při práci s rozhraním API BILLmanager vyvstávají, je, kde získat seznam parametrů? Všechny parametry pro práci s aplikací BILLmanager naleznete v dokumentaci od vývojáře. Úplný seznam pracovních parametrů naleznete po kliknutí na tento odkaz.

Jak získat seznam VDS

Chcete-li získat seznam VDS, musíte provést požadavek na následující adresu URL:

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

Parametry v požadavku:

• authinfo - údaje o autorizaci ve vyúčtování;
• func - funkce provedená ve vyúčtování;
• out - výstupní formát dat, podporovány jsou formáty xml, json a JSONdata.

Ve všech požadavcích musíte použít své osobní údaje, takže změňte username:password na své přihlašovací jméno a heslo a poté proveďte požadavek GET, například pomocí CURL.

Jak objednat VDS

Chcete-li si objednat VDS, musíte provést požadavek na následující 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

Parametry v požadavku:

• authinfo - autorizační údaje ve fakturaci;
• func - funkce prováděná ve vyúčtování;
• addon_X - doplněk k objednání (nepovinný), například k objednání ústředny nebo adres IPv6;
• autoprolong - možnost povolit nebo zakázat automatické obnovení serveru;
• ostempl - šablona OS pro objednávku;
• period - období objednávky, zadává se počet měsíců, podporovány jsou 1, 3, 6, 12;
• pricelist - ID tarifního plánu;
• skipbasket - příznak pro přeskočení fáze vkládání nákupního košíku, pro automatické objednání služby;
• domain - názevdomény serveru (nepovinné);
• sok - potvrzení požadavku.

Změna parametrů serveru

API pro změnu parametrů virtuálního serveru:

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

Pro změnu parametrů vyhrazeného serveru:

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

Parametry v požadavku:

• authinfo - autorizační údaje ve vyúčtování;
• func - funkce prováděná ve vyúčtování;
• elid - kód služby;
• addon_X - doplněk, který se má změnit (nepovinné), například pro změnu počtu IP adres;
• domain - název domény (nepovinné);
• sok - potvrzení požadavku.

Doplňky tarifního plánu při objednávání nebo změně služby prostřednictvím rozhraní API se předávají prostřednictvím parametru addon_, který nabývá hodnoty addon_5=10, kde 5 je kód doplňku, 10 je hodnota.

Při zadávání požadavků API můžete použít konzolu prohlížeče, na kartě "síť" vidíte, jaké požadavky jsou z prohlížeče zadávány při objednávání serveru, stejné parametry lze předávat prostřednictvím požadavků API. Výše uvedený seznam popisuje příklady požadavků API s neúplným seznamem funkcí a parametrů.

Práce s cykly

Pokud potřebujete odebrat VDS, přidat paměť nebo procesorová jádra, můžete to udělat i bez rozhraní BILLmanager API. V případě objednání 10, 100 VDS nebo hromadné změny parametrů serveru však tento proces může trvat několik hodin. Pro takové případy je zvykem používat 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 příkladu je použit požadavek na objednání serveru přes API, seq určuje počet serverů, které se mají objednat. Parametry objednávání serverů jsou podobné jako při objednávání jednoho serveru bez použití cyklů.

Úplná dokumentace k práci s rozhraním API BILLmanager od vývojáře je k dispozici zde.