Kaip dirbti su "BILLmanager" API

API - tai programinės įrangos sąsaja, leidžianti valdyti bet kokią programą naudojant komandų ir funkcijų rinkinį. Pavyzdžiui, yra "Yandex Music API", kurios dėka galite klausytis muzikos įrašų svetainėje. Savo darbe naudojame atsiskaitymo sistemą "BILLmanager".

Ji turi savo API, kurios pagalba galite mastyti serverius lanksčiais tarifais, gauti informaciją apie mokėjimus ir sąskaitos nurašymus. Paprastai bet kuris API kūrėjas savo svetainėje pateikia išsamią dokumentaciją, kaip įdiegti ir konfigūruoti programinės įrangos sąsają.

Tačiau "BILLmanager" API dokumentaciją sunku įsisavinti. Jei norite tapti darbo su API profesionalu, laikas pradėti studijuoti dokumentaciją. Jei jums svarbiausia atlikti užduotį ir gauti rezultatą per trumpą laiką, pakanka pasinaudoti toliau pateiktomis instrukcijomis.

Parametrų sąrašas

Vienas iš pirmųjų klausimų, kylančių dirbant su BILLmanager API, - kur gauti parametrų sąrašą? Visus parametrus, skirtus darbui su BILLmanager, galima rasti kūrėjo dokumentacijoje. Visą darbinių parametrų sąrašą rasite paspaudę šią nuorodą.

Kaip gauti VDS sąrašą

Norėdami gauti VDS sąrašą, turite pateikti užklausą šiuo URL adresu:

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

Užklausos parametrai:

• authinfo - autorizacijos duomenys atsiskaitymo sistemoje;
• func - atsiskaitymuose vykdoma funkcija;
• out - duomenų išvesties formatas, palaikomi xml, json ir JSONduomenys.

Visose užklausose turite naudoti savo asmeninius duomenis, todėl pakeiskite username:password į savo prisijungimo vardą ir slaptažodį, tada atlikite GET užklausą, pavyzdžiui, naudodami CURL.

Kaip užsisakyti VDS

Norėdami užsisakyti VDS, turite pateikti užklausą šiuo URL adresu:

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

Užklausos parametrai:

• authinfo - autorizacijos duomenys atsiskaitymo sistemoje;
• func - atsiskaitymo sistemoje vykdoma funkcija;
• addon_X - užsakomaspriedas (neprivalomas), pavyzdžiui, užsakyti valdymo skydelį arba IPv6 adresus;
• autoprolong - parinktis įjungti arba išjungti automatinį serverio atnaujinimą;
• ostempl - užsakymo OS šablonas;
• period - užsakymo laikotarpis, nurodomas mėnesių skaičius, palaikomi 1, 3, 6, 12 mėnesių;
• pricelist - tarifų plano ID;
• skipbasket - vėliavėlė, skirta praleisti pirkinių krepšelio išrašymo etapą, kad paslauga būtų užsakyta automatiškai;
• domain - serveriodomeno vardas (neprivaloma);
• sok - užklausos patvirtinimas.

Serverio parametrų keitimas

Virtualaus serverio parametrų keitimo API:

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

Norėdami pakeisti dedikuotojo serverio parametrus:

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

Parametrai užklausoje:

• authinfo - autorizacijos duomenys atsiskaitymuose;
• func - funkcija, vykdoma atsiskaitymo sistemoje;
• elid - paslaugos kodas;
• addon_X - keičiamaspriedas (neprivaloma), pavyzdžiui, norint pakeisti IP adresų skaičių;
• domain - domeno vardas (neprivaloma);
• sok - prašymo patvirtinimas.

Tarifo plano papildymai užsakant arba keičiant paslaugą per API perduodami per parametrą addon_, kuris įgyja reikšmę addon_5=10, kur 5 - papildymo kodas, 10 - reikšmė.

Atlikdami API užklausas galite naudoti naršyklės konsolę, skirtuke "tinklas" galite matyti, kokios užklausos atliekamos iš naršyklės užsakant serverį, tie patys parametrai gali būti perduodami per API užklausas. Pirmiau pateiktame sąraše aprašyti API užklausų pavyzdžiai, jame pateiktas neišsamus funkcijų ir parametrų sąrašas.

Darbas su ciklais

Jei reikia pašalinti VDS, pridėti atminties ar procesoriaus branduolių, galite tai padaryti be "BILLmanager" API. Tačiau užsakant 10, 100 VDS arba masiškai keičiant serverio parametrus šis procesas gali užtrukti kelias valandas. Tokiais atvejais įprasta naudoti ciklus:

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

Pavyzdyje naudojama API serverio užsakymo užklausa, seq nurodo užsakomų serverių skaičių. Serverio užsakymo parametrai panašūs į vieno serverio užsakymą nenaudojant ciklų.

Visą kūrėjo dokumentaciją apie darbą su BILLmanager API galima rasti čia.