Cum să lucrați cu BILLmanager API

API este o interfață software care vă permite să controlați orice aplicație prin intermediul unui set de comenzi și funcții. De exemplu, există API-ul Yandex Music, datorită căruia puteți asculta piese muzicale pe site. În activitatea noastră, folosim sistemul de facturare BILLmanager.

Acesta are propriul său API, cu ajutorul căruia puteți scala serverele la tarife flexibile, puteți obține informații despre plăți și debite din cont. De regulă, orice dezvoltator API are pe site-ul său documentație detaliată cu privire la modul de instalare și configurare a interfeței software.

Cu toate acestea, documentația API BILLmanager este dificil de stăpânit. Dacă doriți să deveniți un profesionist în lucrul cu API-ul, atunci este timpul să începeți să studiați documentația. Dacă principalul lucru pentru dvs. este să finalizați sarcina și să obțineți rezultatul într-o perioadă scurtă de timp, este suficient să utilizați instrucțiunile de mai jos.

Lista de parametri

Una dintre primele întrebări care apar atunci când lucrați cu API-ul BILLmanager este de unde să obțineți lista de parametri? Toți parametrii pentru lucrul cu BILLmanager pot fi găsiți în documentația de la dezvoltator. Lista completă a parametrilor de lucru poate fi găsită urmând acest link.

Cum se obține lista de VDS

Pentru a obține lista VDS, trebuie să efectuați o cerere la următoarea adresă URL:

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

Parametrii din cerere:

• authinfo - date de autorizare în facturare;
• func - funcția executată în facturare;
• out - formatul de ieșire a datelor, sunt acceptate xml, json și JSONdata.

În toate solicitările trebuie să utilizați datele dvs. personale, deci schimbați username:password cu login-ul și parola dvs., apoi faceți o solicitare GET, de exemplu, utilizând CURL.

Cum să comandați VDS

Pentru a comanda un VDS, trebuie să faceți o cerere la următoarea adresă 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

Parametrii din cerere:

• authinfo - date de autorizare în facturare;
• func - funcția executată în facturare;
• addon_X -addon de comandat (opțional), de exemplu, pentru a comanda panoul de control sau adresele IPv6;
• autoprolong - opțiune pentru a activa sau dezactiva reînnoirea automată a serverului;
• ostempl - șablon OS pentru comandă;
• period - perioada comenzii, se specifică numărul de luni, sunt acceptate 1, 3, 6, 12;
• pricelist - ID-ul planului tarifar;
• skipbasket - flag pentru sărirea etapei de plasare a coșului de cumpărături, pentru comanda automată a serviciului;
• domain - numele dedomeniu al serverului (opțional);
• sok - confirmarea cererii.

Modificarea parametrilor serverului

API pentru modificarea parametrilor serverului virtual:

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

Pentru a modifica parametrii serverului dedicat:

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

Parametrii din cerere:

• authinfo - date de autorizare în facturare;
• func - funcția executată în facturare;
• elid - codul serviciului;
• addon_X - addon de schimbat (opțional), de exemplu, pentru a schimba numărul de adrese IP;
• domain - numele domeniului (opțional);
• sok - confirmarea cererii.

Adaosurile la planul tarifar la comanda sau schimbarea unui serviciu prin API sunt transmise prin parametrul addon_, care ia valoarea addon_5=10, unde 5 este codul adaosului, iar 10 este valoarea.

Atunci când efectuați cereri API, puteți utiliza consola browserului, în fila "rețea" puteți vedea ce cereri sunt efectuate din browser atunci când comandați un server, aceiași parametri pot fi trecuți prin cereri API. Lista de mai sus descrie exemple de cereri API, cu o listă incompletă de funcții și parametri.

Lucrul cu ciclurile

Dacă trebuie să eliminați VDS, să adăugați memorie sau nuclee de procesor, o puteți face fără API BILLmanager. Cu toate acestea, în cazul comandării a 10, 100 VDS sau al schimbării în masă a parametrilor serverului, acest proces poate dura câteva ore. Se obișnuiește să se utilizeze cicluri pentru astfel de cazuri:

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

Exemplul utilizează solicitarea de comandă a serverului API, seq specifică numărul de servere de comandat. Parametrii de comandă a serverelor sunt similari cu comanda unui singur server fără a utiliza cicluri.

Documentația completă privind lucrul cu API BILLmanager de la dezvoltator este disponibilă aici.