Jak pracować z BILLmanager API

API to interfejs oprogramowania, który umożliwia sterowanie dowolną aplikacją za pomocą zestawu poleceń i funkcji. Na przykład istnieje Yandex Music API, dzięki któremu można słuchać utworów muzycznych na stronie. W naszej pracy korzystamy z systemu rozliczeniowego BILLmanager.

Ma własne API, za pomocą którego można skalować serwery według elastycznych taryf, uzyskiwać informacje o płatnościach i obciążeniach konta. Z reguły każdy twórca API ma na swojej stronie internetowej szczegółową dokumentację dotyczącą instalacji i konfiguracji interfejsu oprogramowania.

Jednak dokumentacja API BILLmanager jest trudna do opanowania. Jeśli chcesz zostać profesjonalistą w pracy z API, czas zacząć studiować dokumentację. Jeśli najważniejsze jest wykonanie zadania i uzyskanie wyniku w krótkim czasie, wystarczy skorzystać z poniższych instrukcji.

Lista parametrów

Jednym z pierwszych pytań pojawiających się podczas pracy z API BILLmanager jest to, skąd wziąć listę parametrów? Wszystkie parametry do pracy z BILLmanager można znaleźć w dokumentacji od dewelopera. Pełną listę parametrów roboczych można znaleźć, klikając ten link.

Jak uzyskać listę VDS

Aby uzyskać listę VDS, należy wysłać żądanie na następujący adres URL:

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

Parametry w żądaniu:

• authinfo - dane autoryzacyjne w billingach;
• func - funkcja wykonywana w rozliczeniu;
• out - format wyjściowy danych, obsługiwane są xml, json i JSONdata.

We wszystkich żądaniach musisz użyć swoich danych osobowych, więc zmień username:password na swój login i hasło, a następnie wykonaj żądanie GET, na przykład za pomocą CURL.

Jak zamówić VDS

Aby zamówić VDS, należy wysłać żądanie na następujący 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

Parametry w żądaniu:

• authinfo - dane autoryzacyjne w billingach;
• func - funkcja wykonywana w rozliczeniu;
• addon_X - dodatek do zamówienia (opcjonalny), na przykład, aby zamówić panel sterowania lub adresy IPv6;
• autoprolong - opcja włączenia lub wyłączenia automatycznego odnawiania serwera;
• ostempl - szablon systemu operacyjnego dla zamówienia;
• period - okres zamówienia, liczba miesięcy jest określona, obsługiwane są 1, 3, 6, 12;
• pricelist - identyfikator planu taryfowego;
• skipbasket - flaga umożliwiająca pominięcie etapu realizacji zamówienia w koszyku, w celu automatycznego zamówienia usługi;
• domain - nazwadomeny serwera (opcjonalnie);
• sok - potwierdzenie żądania.

Zmiana parametrów serwera

API do zmiany parametrów serwera wirtualnego:

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

Aby zmienić parametry serwera dedykowanego:

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

Parametry w żądaniu:

• authinfo - dane autoryzacyjne w billingach;
• func - funkcja wykonywana w billingach;
• elid - kod usługi;
• addon_X - addon do zmiany (opcjonalnie), na przykład, aby zmienić liczbę adresów IP;
• domain - nazwa domeny (opcjonalnie);
• sok - potwierdzenie żądania.

Dodatki do planu taryfowego podczas zamawiania lub zmiany usługi za pośrednictwem interfejsu API są przekazywane za pośrednictwem parametru addon_, który przyjmuje wartość addon_5=10, gdzie 5 to kod dodatku, 10 to wartość.

Podczas wykonywania żądań API można użyć konsoli przeglądarki, na karcie "sieć" można zobaczyć, jakie żądania są wykonywane z przeglądarki podczas zamawiania serwera, te same parametry mogą być przekazywane za pośrednictwem żądań API. Powyższa lista opisuje przykłady żądań API, z niepełną listą funkcji i parametrów.

Praca z cyklami

Jeśli chcesz usunąć VDS, dodać pamięć lub rdzenie procesora, możesz to zrobić bez API BILLmanager. Jednak w przypadku zamawiania 10, 100 VDS lub masowej zmiany parametrów serwera proces ten może zająć kilka godzin. W takich przypadkach zwykle stosuje się cykle:

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

Przykład wykorzystuje żądanie zamówienia serwera API, seq określa liczbę serwerów do zamówienia. Parametry zamawiania serwera są podobne do zamawiania pojedynczego serwera bez użycia pętli.

Pełna dokumentacja dotycząca pracy z API BILLmanager od dewelopera jest dostępna tutaj.