Kuinka työskennellä BILLmanager API:n kanssa

API on ohjelmistorajapinta, jonka avulla voit hallita mitä tahansa sovellusta komentojen ja toimintojen avulla. Esimerkiksi on olemassa Yandex Music API, jonka ansiosta voit kuunnella musiikkikappaleita sivustolla. Käytämme työssämme BILLmanager-laskutusjärjestelmää.

Sillä on oma API, jonka avulla voit skaalata palvelimia joustavilla tariffeilla, saada tietoja maksuista ja tiliveloituksista. Pääsääntöisesti jokaisella API-kehittäjällä on verkkosivuillaan yksityiskohtainen dokumentaatio siitä, miten ohjelmistorajapinta asennetaan ja konfiguroidaan.

BILLmanagerin API-dokumentaatiota on kuitenkin vaikea hallita. Jos haluat tulla ammattilaiseksi API:n kanssa työskentelyssä, on aika aloittaa dokumentaation tutkiminen. Jos sinulle on tärkeintä suorittaa tehtävä ja saada tulos lyhyessä ajassa, riittää, että käytät alla olevia ohjeita.

Parametrien luettelo

Yksi ensimmäisistä kysymyksistä, jotka heräävät BILLmanager API:n kanssa työskenneltäessä, on se, mistä saa luettelon parametreista? Kaikki BILLmanagerin kanssa työskentelyyn tarvittavat parametrit löytyvät kehittäjän dokumentaatiosta. Täydellinen luettelo työskentelyparametreista löytyy tämän linkin takaa.

Miten saada luettelo VDS:stä

Saadaksesi VDS-luettelon sinun on tehtävä pyyntö seuraavaan URL-osoitteeseen:

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

Pyynnön parametrit:

• authinfo - valtuutustiedot laskutuksessa;
• func - laskutuksessa suoritettu toiminto;
• out - tietojen tulostusmuoto, xml-, json- ja JSON-tiedot ovat tuettuja.

Kaikissa pyynnöissä sinun on käytettävä henkilökohtaisia tietojasi, joten vaihda käyttäjätunnus:salasana käyttäjätunnukseksesi ja salasanaksesi ja tee sitten GET-pyyntö esimerkiksi CURL-ohjelmalla.

VDS:n tilaaminen

Tilataksesi VDS:n sinun on tehtävä pyyntö seuraavaan URL-osoitteeseen:

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

Pyynnön parametrit:

• authinfo - valtuutustiedot laskutuksessa;
• func - laskutuksessa suoritettu toiminto;
• addon_X - tilattavalisäosa (valinnainen), esimerkiksi ohjauspaneelin tai IPv6-osoitteiden tilaaminen;
• autoprolong - vaihtoehto, jolla voidaan ottaa käyttöön tai poistaa käytöstä palvelimen automaattinen uusiminen;
• ostempl - tilauksen käyttöjärjestelmämalli;
• period - tilauksen kesto, kuukausien määrä määritetään, tuettuja kuukausia ovat 1, 3, 6, 12;
• pricelist - tariffisuunnitelman tunnus;
• skipbasket - lippu ostoskorin asettamisvaiheen ohittamista varten, palvelun automaattista tilaamista varten;
• domain - palvelimenverkkotunnus (valinnainen);
• sok - pyynnön vahvistus.

Palvelimen parametrien muuttaminen

API virtuaalipalvelimen parametrien muuttamista varten:

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

Omistetun palvelimen parametrien muuttaminen:

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

Pyynnön parametrit:

• authinfo - valtuutustiedot laskutuksessa;
• func - laskutuksessa suoritettu toiminto;
• elid - palvelukoodi;
• addon_X - muutettavalisäosa (valinnainen), esimerkiksi IP-osoitteiden määrän muuttaminen;
• domain - verkkotunnus (valinnainen);
• sok - pyynnön vahvistus.

Lisäykset tariffisuunnitelmaan tilattaessa tai muutettaessa palvelua API:n kautta välitetään addon_-parametrin kautta, jonka arvo on addon_5=10, jossa 5 on lisäyksen koodi ja 10 on arvo.

API-pyyntöjä tehdessäsi voit käyttää selaimen konsolia, "verkko"-välilehdellä näet, mitä pyyntöjä selaimesta tehdään palvelinta tilattaessa, samat parametrit voidaan välittää API-pyyntöjen kautta. Yllä olevassa luettelossa kuvataan esimerkkejä API-pyynnöistä, ja luettelo toiminnoista ja parametreista on epätäydellinen.

Työskentely syklien kanssa

Jos sinun on poistettava VDS:ää, lisättävä muistia tai prosessoriytimiä, voit tehdä sen ilman BILLmanager API:ta. Jos kuitenkin tilaat 10 tai 100 VDS:ää tai palvelinparametrien massamuutoksia, tämä prosessi voi kestää useita tunteja. Tällaisissa tapauksissa on tapana käyttää syklejä:

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

Esimerkissä käytetään API-palvelintilauspyyntöä, seq määrittää tilattavien palvelinten määrän. Palvelinten tilausparametrit ovat samanlaiset kuin yksittäisen palvelimen tilaaminen ilman silmukoita.

Täydellinen dokumentaatio BILLmanager API:n kanssa työskentelystä kehittäjältä löytyy täältä.