Hogyan dolgozzon a BILLmanager API-val

Az API egy olyan szoftverfelület, amely lehetővé teszi bármely alkalmazás vezérlését parancsok és funkciók segítségével. Ott van például a Yandex Music API, amelynek köszönhetően zeneszámokat hallgathat az oldalon. Munkánk során a BILLmanager számlázási rendszert használjuk.

Ennek saját API-ja van, amelynek segítségével rugalmas tarifák mellett skálázhatja a szervereket, információt kaphat a fizetésekről és a számla terheléséről. Általában minden API-fejlesztő részletes dokumentációval rendelkezik a weboldalán arról, hogyan kell telepíteni és konfigurálni a szoftver interfészét.

A BILLmanager API dokumentációját azonban nehéz elsajátítani. Ha az API-val való munkavégzésben profi szakemberré szeretne válni, akkor itt az ideje, hogy elkezdje tanulmányozni a dokumentációt. Ha az a legfontosabb az Ön számára, hogy rövid idő alatt elvégezze a feladatot és eredményt érjen el, akkor elég, ha az alábbi utasításokat használja.

A paraméterek listája

A BILLmanager API-val való munka során felmerülő egyik első kérdés az, hogy honnan szerezhetjük be a paraméterek listáját? A BILLmanagerrel való munkához szükséges összes paraméter megtalálható a fejlesztő dokumentációjában. A munkaparaméterek teljes listája ezen a linken érhető el.

Hogyan szerezheti meg a VDS listáját

A VDS-ek listájának lekérdezéséhez a következő URL-címre kell kérést küldenie:

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

A kérés paraméterei:

• authinfo - számlázási jogosultsági adatok;
• func - a számlázásban végrehajtott funkció;
• out - az adatok kimeneti formátuma, xml, json és JSON adatok támogatottak.

Minden kérésben a személyes adatait kell használnia, ezért a felhasználónév:jelszó értéket változtassa meg a bejelentkezési adataira és jelszavára, majd készítsen GET kérést, például a CURL segítségével.

Hogyan rendelhet VDS-t

A VDS megrendeléséhez a következő URL-címre kell kérést küldenie:

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

A kérés paraméterei:

• authinfo - jogosultsági adatok a számlázásban;
• func - a számlázásban végrehajtott funkció;
• addon_X - a megrendelni kívántkiegészítő (opcionális), például vezérlőpanel vagy IPv6-címek rendelése;
• autoprolong - a szerver automatikus megújításának engedélyezésére vagy letiltására szolgáló opció;
• ostempl - OS sablon a megrendeléshez;
• period - a rendelési időszak, a hónapok száma van megadva, 1, 3, 6, 12 hónap támogatott;
• pricelist - díjcsomag azonosítója;
• skipbasket - a kosárpénztár szakaszának kihagyását jelző zászló, a szolgáltatás automatikus megrendeléséhez;
• domain - a szerverdomainneve (opcionális);
• sok - kérés visszaigazolása.

A szerver paramétereinek módosítása

API a virtuális szerver paramétereinek módosítására:

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

A dedikált szerver paramétereinek módosítása:

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

A kérelemben szereplő paraméterek:

• authinfo - jogosultsági adatok a számlázásban;
• func - a számlázásban végrehajtott funkció;
• elid - a szolgáltatás kódja;
• addon_X - a módosítandóbővítmény (opcionális), például az IP-címek számának módosítása;
• domain - domain név (opcionális);
• sok - kérés visszaigazolása.

A díjszabás kiegészítései a szolgáltatás API-n keresztül történő megrendelése vagy módosítása során az addon_ paraméteren keresztül kerülnek átadásra, amely az addon_5=10 értéket veszi fel, ahol 5 a kiegészítés kódja, 10 az érték.

Az API-kérések során a böngésző konzolját használhatja, a "hálózat" fülön láthatja, hogy milyen kérések történnek a böngészőből a szerver megrendelésekor, ugyanazok a paraméterek adhatók át az API-kéréseken keresztül. A fenti lista példákat ír le az API-kérésekre, a funkciók és paraméterek nem teljes listájával.

Ciklusokkal való munka

Ha VDS-t kell eltávolítania, memóriát vagy processzormagokat kell hozzáadnia, azt a BILLmanager API nélkül is megteheti. Azonban 10, 100 VDS megrendelése vagy a szerver paramétereinek tömeges módosítása esetén ez a folyamat több órát is igénybe vehet. Ilyen esetekben szokás a ciklusok használata:

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

A példa API szerverrendelési kérést használ, a seq megadja a megrendelendő szerverek számát. A szerverrendelés paraméterei hasonlóak egyetlen szerver megrendeléséhez ciklusok használata nélkül.

A BILLmanager API-val való munkavégzés teljes dokumentációja a fejlesztőtől itt érhető el.