Wie man mit BILLmanager API arbeitet

API ist eine Softwareschnittstelle, die es Ihnen ermöglicht, jede Anwendung über eine Reihe von Befehlen und Funktionen zu steuern. So gibt es zum Beispiel die Yandex Music API, mit der Sie auf der Website Musiktitel anhören können. In unserer Arbeit verwenden wir das Abrechnungssystem BILLmanager.

Es verfügt über eine eigene API, mit deren Hilfe Sie Server zu flexiblen Tarifen skalieren, Informationen über Zahlungen und Kontobelastungen erhalten können. In der Regel verfügt jeder API-Entwickler auf seiner Website über eine ausführliche Dokumentation zur Installation und Konfiguration der Software-Schnittstelle.

Die BILLmanager API-Dokumentation ist jedoch schwer zu bewältigen. Wenn Sie ein Profi im Umgang mit der API werden wollen, dann ist es an der Zeit, die Dokumentation zu studieren. Wenn es Ihnen vor allem darum geht, die Aufgabe in kurzer Zeit zu erledigen und das Ergebnis zu erhalten, reicht es aus, die unten stehenden Anweisungen zu verwenden.

Liste der Parameter

Eine der ersten Fragen, die sich bei der Arbeit mit der BILLmanager API stellt, ist die Frage, woher man die Liste der Parameter bekommt. Alle Parameter für die Arbeit mit BILLmanager können in der Dokumentation des Entwicklers nachgelesen werden. Die vollständige Liste der Arbeitsparameter finden Sie unter diesem Link.

Wie man die Liste der VDS erhält

Um die Liste der VDS zu erhalten, müssen Sie eine Anfrage an die folgende URL stellen:

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

Parameter in der Anfrage:

• authinfo - Autorisierungsdaten in der Rechnungsstellung;
• func - in der Rechnungsstellung ausgeführte Funktion;
• out - Datenausgabeformat, xml, json und JSONdata werden unterstützt.

In allen Anfragen müssen Sie Ihre persönlichen Daten verwenden, also ändern Sie username:password in Ihr Login und Passwort und stellen Sie dann eine GET-Anfrage, zum Beispiel mit CURL.

Wie man VDS bestellt

Um ein VDS zu bestellen, müssen Sie eine Anfrage an die folgende URL stellen:

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

Parameter in der Anfrage:

• authinfo - Autorisierungsdaten in der Rechnungsstellung;
• func - Funktion, die in der Rechnungsstellung ausgeführt wird;
• addon_X - zu bestellendesAddon (optional), z. B. um ein Control Panel oder IPv6-Adressen zu bestellen;
• autoprolong - Option zur Aktivierung oder Deaktivierung der automatischen Servererneuerung;
• ostempl - OS-Vorlage für die Bestellung;
• period - Bestellzeitraum, die Anzahl der Monate wird angegeben, 1, 3, 6, 12 werden unterstützt;
• pricelist - Tarifplan-ID;
• skipbasket - Flagge für das Überspringen der Phase des Warenkorbs, für die automatische Bestellung des Dienstes;
• domain -Domain-Name des Servers (optional);
• sok - Bestätigung der Anfrage.

Ändern von Serverparametern

API zur Änderung der Parameter des virtuellen Servers:

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

So ändern Sie dedizierte Server-Parameter:

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

Parameter in der Anfrage:

• authinfo - Autorisierungsdaten in der Abrechnung;
• func - Funktion, die in der Abrechnung ausgeführt wird;
• elid - Dienst-Code;
• addon_X - zu änderndesAddon (optional), z.B. um die Anzahl der IP-Adressen zu ändern;
• domain - Domain-Name (optional);
• sok - Auftragsbestätigung.

Zusätze zum Tarifplan bei der Bestellung oder Änderung eines Dienstes über API werden über den Parameter addon_ übergeben, der den Wert addon_5=10 annimmt, wobei 5 der Code des Zusatzes und 10 der Wert ist.

Wenn Sie API-Anfragen stellen, können Sie die Browserkonsole verwenden. Auf der Registerkarte "Netzwerk" können Sie sehen, welche Anfragen vom Browser aus gestellt werden, wenn Sie einen Server bestellen; die gleichen Parameter können über API-Anfragen übergeben werden. Die obige Liste beschreibt Beispiele für API-Anfragen, mit einer unvollständigen Liste von Funktionen und Parametern.

Arbeiten mit Zyklen

Wenn Sie VDS entfernen, Speicher oder Prozessorkerne hinzufügen müssen, können Sie dies ohne BILLmanager API tun. Im Falle einer Bestellung von 10 oder 100 VDS oder einer Massenänderung von Serverparametern kann dieser Prozess jedoch mehrere Stunden dauern. Es ist üblich, für solche Fälle Zyklen zu verwenden:

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

Das Beispiel verwendet eine API-Serverbestellanfrage, die seq gibt die Anzahl der zu bestellenden Server an. Die Serverbestellungsparameter sind ähnlich wie bei der Bestellung eines einzelnen Servers, ohne Schleifen zu verwenden.

Die vollständige Dokumentation zur Arbeit mit der BILLmanager-API vom Entwickler ist hier verfügbar.