Sådan arbejder du med BILLmanager API

API er en softwaregrænseflade, der giver dig mulighed for at styre et hvilket som helst program gennem et sæt kommandoer og funktioner. For eksempel er der Yandex Music API, takket være hvilken du kan lytte til musiknumre på webstedet. I vores arbejde bruger vi faktureringssystemet BILLmanager.

Det har sin egen API, ved hjælp af hvilken du kan skalere servere til fleksible takster, få oplysninger om betalinger og kontodebiteringer. Som regel har enhver API-udvikler detaljeret dokumentation på sin hjemmeside om, hvordan man installerer og konfigurerer softwaregrænsefladen.

BILLmanagers API-dokumentation er dog svær at mestre. Hvis du ønsker at blive professionel i arbejdet med API'en, er det på tide at begynde at studere dokumentationen. Hvis det vigtigste for dig er at fuldføre opgaven og få resultatet på kort tid, er det nok at bruge instruktionerne nedenfor.

Liste over parametre

Et af de første spørgsmål, der opstår, når man arbejder med BILLmanager API, er, hvor man kan få listen over parametre? Alle parametre til at arbejde med BILLmanager kan findes i dokumentationen fra udvikleren. Den fulde liste over arbejdsparametre kan findes ved at følge dette link.

Sådan får du listen over VDS'er

For at få listen over VDS'er skal du lave en anmodning til følgende URL:

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

Parametre i anmodningen:

• authinfo - autorisationsdata i fakturering;
• func - funktion udført i fakturering;
• out - dataoutputformat, xml, json og JSONdata understøttes.

I alle anmodninger skal du bruge dine personlige data, så skift brugernavn:adgangskode til dit login og din adgangskode, og lav derefter en GET-anmodning, f.eks. ved hjælp af CURL.

Sådan bestiller du VDS'er

For at bestille en VDS skal du sende en anmodning til følgende 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

Parametre i anmodningen:

• authinfo - autorisationsdata i fakturering;
• func - funktion udført i fakturering;
• addon_X - addon, der skal bestilles (valgfrit), f.eks. for at bestille kontrolpanel eller IPv6-adresser;
• autoprolong - mulighed for at aktivere eller deaktivere automatisk serverfornyelse;
• ostempl - OS-skabelon for ordren;
• period - ordreperiode, antallet af måneder specificeres, 1, 3, 6, 12 understøttes;
• pricelist - ID for takstplan;
• skipbasket - flag for at springe stadiet med indkøbskurv over til automatisk bestilling af tjenesten;
• domain - serverensdomænenavn (valgfrit);
• sok - bekræftelse af anmodning.

Ændring af serverparametre

API til ændring af virtuelle serverparametre:

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

For at ændre dedikerede serverparametre:

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

Parametre i anmodningen:

• authinfo - autorisationsdata i fakturering;
• func - funktion udført i fakturering;
• elid - servicekode;
• addon_X - addon, der skal ændres (valgfrit), f.eks. for at ændre antallet af IP-adresser;
• domain - domænenavn (valgfrit);
• sok - anmodning om bekræftelse.

Tilføjelser til takstplanen, når du bestiller eller ændrer en tjeneste via API, sendes gennem addon_-parameteren, som har værdien addon_5=10, hvor 5 er koden for tilføjelsen, og 10 er værdien.

Når du foretager API-anmodninger, kan du bruge browserkonsollen, på fanen "netværk" kan du se, hvilke anmodninger der foretages fra browseren, når du bestiller en server, de samme parametre kan sendes gennem API-anmodninger. Listen ovenfor beskriver eksempler på API-anmodninger med en ufuldstændig liste over funktioner og parametre.

Arbejde med cyklusser

Hvis du har brug for at fjerne VDS'er, tilføje hukommelse eller processorkerner, kan du gøre det uden BILLmanager API. Men i tilfælde af bestilling af 10, 100 VDS'er eller masseændring af serverparametre kan denne proces tage flere timer. Det er almindeligt at bruge cyklusser i sådanne tilfælde:

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

Eksemplet bruger API-serverordreanmodning, seq angiver antallet af servere, der skal bestilles. Serverbestillingsparametre svarer til at bestille en enkelt server uden at bruge loops.

Fuld dokumentation om at arbejde med BILLmanager API fra udvikleren er tilgængelig her.