Werken met BILLmanager API

API is een software-interface waarmee je een toepassing kunt bedienen via een reeks commando's en functies. Zo is er bijvoorbeeld de Yandex Music API, waarmee je muzieknummers op de site kunt beluisteren. In ons werk gebruiken we het factureringssysteem BILLmanager.

Het heeft zijn eigen API, waarmee je servers kunt schalen tegen flexibele tarieven, informatie kunt krijgen over betalingen en rekeningafschrijvingen. In de regel heeft elke API-ontwikkelaar gedetailleerde documentatie op zijn website over hoe de software-interface geïnstalleerd en geconfigureerd moet worden.

De BILLmanager API documentatie is echter moeilijk onder de knie te krijgen. Als je een professional wilt worden in het werken met de API, dan is het tijd om de documentatie te gaan bestuderen. Als het belangrijkste voor u is om de taak te voltooien en het resultaat in korte tijd te krijgen, dan is het voldoende om de onderstaande instructies te gebruiken.

Lijst van parameters

Een van de eerste vragen die opkomen bij het werken met de BILLmanager API is waar je de lijst met parameters kunt vinden. Alle parameters voor het werken met BILLmanager zijn te vinden in de documentatie van de ontwikkelaar. De volledige lijst met werkende parameters is te vinden via deze link.

Hoe krijg ik de lijst met VDS

Om de lijst met VDS op te vragen, moet je een verzoek doen naar de volgende URL:

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

Parameters in het verzoek:

• authinfo - autorisatiegegevens in facturering;
• func - functie uitgevoerd in facturering;
• out - gegevensuitvoerformaat, xml, json en JSONdata worden ondersteund.

In alle verzoeken moet u uw persoonlijke gegevens gebruiken, dus wijzig gebruikersnaam:wachtwoord in uw login en wachtwoord en doe vervolgens een GET-verzoek met bijvoorbeeld CURL.

Hoe bestel ik een VDS?

Om een VDS te bestellen, moet je een aanvraag doen via de volgende 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

Parameters in het verzoek:

• authinfo - autorisatiegegevens in facturering;
• func - functie uitgevoerd in facturering;
• addon_X -addon om te bestellen (optioneel), bijvoorbeeld om controlepaneel of IPv6-adressen te bestellen;
• autoprolong - optie om automatische serververnieuwing in of uit te schakelen;
• ostempl - OS sjabloon voor de bestelling;
• periode - bestelperiode, het aantal maanden wordt gespecificeerd, 1, 3, 6, 12 worden ondersteund;
• pricelist - tariefplan ID;
• skipbasket - vlag voor het overslaan van de fase van het plaatsen van het winkelmandje, voor het automatisch bestellen van de dienst;
• domein -domeinnaam van de server (optioneel);
• sok - aanvraagbevestiging.

Serverparameters wijzigen

API voor het wijzigen van virtuele serverparameters:

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

Specifieke serverparameters wijzigen:

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

Parameters in het verzoek:

• authinfo - autorisatiegegevens in facturering;
• func - functie uitgevoerd in facturering;
• elid - servicecode;
• addon_X -addon om te wijzigen (optioneel), bijvoorbeeld om het aantal IP-adressen te wijzigen;
• domein - domeinnaam (optioneel);
• sok - verzoek om bevestiging.

Toevoegingen aan het tariefplan bij het bestellen of wijzigen van een dienst via API worden doorgegeven via de addon_ parameter, die de waarde addon_5=10 aanneemt, waarbij 5 de code van de toevoeging is en 10 de waarde.

Bij het maken van API-verzoeken kun je de browserconsole gebruiken, op het tabblad "netwerk" kun je zien welke verzoeken er vanuit de browser worden gedaan bij het bestellen van een server, dezelfde parameters kunnen worden doorgegeven via API-verzoeken. De bovenstaande lijst beschrijft voorbeelden van API-verzoeken, met een onvolledige lijst van functies en parameters.

Werken met cycli

Als je VDS moet verwijderen, geheugen of processorkernen moet toevoegen, kun je dit doen zonder BILLmanager API. Echter, in het geval van het bestellen van 10, 100 VDS of massale verandering van serverparameters, kan dit proces enkele uren duren. Het is gebruikelijk om in dergelijke gevallen cycli te gebruiken:

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

Het voorbeeld gebruikt API serverbestelverzoeken, de seq specificeert het aantal servers dat moet worden besteld. Serverbestelparameters zijn vergelijkbaar met het bestellen van een enkele server zonder lussen te gebruiken.

Volledige documentatie over het werken met de BILLmanager API van de ontwikkelaar is hier beschikbaar.