Kuidas töötada BILLmanager API-ga

API on tarkvaraliides, mis võimaldab juhtida mis tahes rakendust käskude ja funktsioonide abil. Näiteks on olemas Yandex Music API, tänu millele saate kuulata muusikapilte saidil. Meie töös kasutame BILLmanager arveldussüsteemi.

Sellel on oma API, mille abil saab skaleerida servereid paindlike tariifidega, saada teavet maksete ja konto debiteerimise kohta. Reeglina on igal API arendajal oma veebilehel üksikasjalik dokumentatsioon selle kohta, kuidas tarkvaraliidest paigaldada ja seadistada.

BILLmanager API dokumentatsiooni on aga raske omandada. Kui soovite saada API-ga töötamise professionaaliks, siis on aeg hakata dokumentatsiooni uurima. Kui teie jaoks on peamine, et täita ülesanne ja saada tulemus lühikese aja jooksul, piisab allpool toodud juhistest.

Parameetrite loetelu

Üks esimesi küsimusi, mis tekib BILLmanager API-ga töötades, on see, kust saada parameetrite loetelu? Kõik BILLmanageriga töötamiseks vajalikud parameetrid leiate arendaja dokumentatsioonist. Töötavate parameetrite täielik loetelu on leitav selle lingi kaudu.

Kuidas saada VDS-i nimekirja

VDS-i nimekirja saamiseks tuleb teha päring järgmisele URL-ile:

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

Taotluse parameetrid:

• authinfo - autoriseerimisandmed arvelduses;
• func - funktsioon, mida täidetakse arvelduses;
• out - andmete väljundformaat, toetatakse xml, json ja JSONdata.

Kõigis päringutes peate kasutama oma isikuandmeid, seega muutke kasutajanimi:parool oma kasutajatunnuse ja parooliga, seejärel tehke GET päring, kasutades näiteks CURL-i.

Kuidas tellida VDSi

VDSi tellimiseks peate tegema päringu järgmisele URL-ile:

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

Taotluse parameetrid:

• authinfo - autoriseerimisandmed arvelduses;
• func - funktsioon, mida täidetakse arvelduses;
• addon_X - tellitavlisand (valikuline), näiteks juhtpaneeli või IPv6-aadresside tellimiseks;
• autoprolong - võimalus lubada või keelata serveri automaatne uuendamine;
• ostempl - tellimuse operatsioonisüsteemi mall;
• period - tellimuse periood, määratakse kuude arv, toetatakse 1, 3, 6, 12 kuud;
• pricelist - tariifiplaani ID;
• skipbasket - lipuke ostukorvi paigutamise etapi vahelejätmiseks, teenuse automaatseks tellimiseks;
• domeen - serveridomeeninimi (valikuline);
• sok - taotluse kinnitus.

Serveri parameetrite muutmine

API virtuaalse serveri parameetrite muutmiseks:

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

Spetsiaalse serveri parameetrite muutmiseks:

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

Parameetrid taotluses:

• authinfo - autoriseerimisandmed arvelduses;
• func - funktsioon, mida täidetakse arvelduses;
• elid - teenuse kood;
• addon_X - muudetavlisa (valikuline), näiteks IP-aadresside arvu muutmine;
• domeen - domeeninimi (vabatahtlik);
• sok - taotluse kinnitus.

Teenuse tellimisel või muutmisel API kaudu edastatakse tariifiplaani täiendused läbi parameetri addon_, mis võtab väärtuse addon_5=10, kus 5 on täienduse kood, 10 on väärtus.

API päringute tegemisel saate kasutada brauseri konsooli, vahekaardil "võrk" näete, milliseid päringuid tehakse brauserist serveri tellimisel, samu parameetreid saab edastada ka API päringute kaudu. Ülaltoodud loetelus on kirjeldatud näiteid API päringute kohta, funktsioonide ja parameetrite loetelu on puudulik.

Töötamine tsüklitega

Kui teil on vaja eemaldada VDS, lisada mälu või protsessori südamikud, saate seda teha ilma BILLmanager API-ta. Kuid 10, 100 VDSi tellimise või serveriparameetrite massilise muutmise korral võib see protsess võtta mitu tundi. Sellistel juhtudel on kombeks kasutada tsükleid:

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

Näites kasutatakse API serverite tellimise taotlust, seq määrab tellitavate serverite arvu. Serveri tellimise parameetrid on sarnased ühe serveri tellimisele ilma tsüklite kasutamiseta.

BILLmanager APIga töötamise täielik dokumentatsioon arendajalt on saadaval siin.