Come lavorare con l'API di BILLmanager

L'API è un'interfaccia software che consente di controllare qualsiasi applicazione attraverso un insieme di comandi e funzioni. Ad esempio, esiste l'API di Yandex Music, grazie alla quale è possibile ascoltare i brani musicali sul sito. Nel nostro lavoro, utilizziamo il sistema di fatturazione BILLmanager.

Ha una propria API, con l'aiuto della quale è possibile scalare i server a tariffe flessibili, ottenere informazioni sui pagamenti e sugli addebiti in conto. Di norma, qualsiasi sviluppatore di API mette a disposizione sul proprio sito web una documentazione dettagliata su come installare e configurare l'interfaccia del software.

Tuttavia, la documentazione dell'API di BILLmanager è difficile da padroneggiare. Se volete diventare dei professionisti nel lavoro con l'API, allora è il momento di iniziare a studiare la documentazione. Se la cosa principale per voi è completare il compito e ottenere il risultato in breve tempo, è sufficiente utilizzare le istruzioni riportate di seguito.

Elenco dei parametri

Una delle prime domande che sorgono quando si lavora con l'API di BILLmanager è dove trovare l'elenco dei parametri. Tutti i parametri per lavorare con BILLmanager si trovano nella documentazione dello sviluppatore. L'elenco completo dei parametri di lavoro è disponibile seguendo questo link.

Come ottenere l'elenco dei VDS

Per ottenere l'elenco dei VDS, è necessario effettuare una richiesta al seguente URL:

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

Parametri della richiesta:

• authinfo - dati di autorizzazione nella fatturazione;
• func - funzione eseguita nella fatturazione;
• out - formato di output dei dati, sono supportati xml, json e JSONdata.

In tutte le richieste è necessario utilizzare i propri dati personali, quindi cambiare username:password con il proprio login e password, quindi effettuare una richiesta GET, ad esempio, utilizzando CURL.

Come ordinare un VDS

Per ordinare una VDS, è necessario effettuare una richiesta al seguente 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

Parametri della richiesta:

• authinfo - dati di autorizzazione nella fatturazione;
• func - funzione eseguita nella fatturazione;
• addon_X -addon da ordinare (opzionale), ad esempio per ordinare il pannello di controllo o gli indirizzi IPv6;
• autoprolong - opzione per attivare o disattivare il rinnovo automatico del server;
• ostempl - modello di sistema operativo per l'ordine;
• period - periodo dell'ordine, in cui viene specificato il numero di mesi; sono supportati 1, 3, 6, 12;
• pricelist - ID del piano tariffario;
• skipbasket - flag per saltare la fase di checkout del carrello, per l'ordine automatico del servizio;
• domain - nomedel dominio del server (opzionale);
• sok - conferma della richiesta.

Modifica dei parametri del server

API per la modifica dei parametri del server virtuale:

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

Per modificare i parametri del server dedicato:

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

Parametri nella richiesta:

• authinfo - dati di autorizzazione nella fatturazione;
• func - funzione eseguita nella fatturazione;
• elid - codice del servizio;
• addon_X -addon da modificare (opzionale), ad esempio per cambiare il numero di indirizzi IP;
• domain - nome del dominio (opzionale);
• sok - richiesta di conferma.

Le aggiunte al piano tariffario quando si ordina o si modifica un servizio tramite API vengono passate attraverso il parametro addon_, che assume il valore addon_5=10, dove 5 è il codice dell'aggiunta, 10 il valore.

Quando si effettuano richieste API è possibile utilizzare la console del browser, nella scheda "rete" è possibile vedere quali richieste vengono effettuate dal browser quando si ordina un server, gli stessi parametri possono essere passati attraverso le richieste API. L'elenco precedente descrive esempi di richieste API, con un elenco incompleto di funzioni e parametri.

Lavorare con i cicli

Se è necessario rimuovere VDS, aggiungere memoria o core di processore, è possibile farlo senza l'API di BILLmanager. Tuttavia, in caso di ordine di 10 o 100 VDS o di modifica massiccia dei parametri del server, questo processo può richiedere diverse ore. In questi casi è consuetudine utilizzare dei cicli:

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

L'esempio utilizza la richiesta di ordine di server API, il seq specifica il numero di server da ordinare. I parametri di ordinazione dei server sono simili all'ordinazione di un singolo server senza l'uso di cicli.

La documentazione completa sul funzionamento dell'API di BILLmanager fornita dallo sviluppatore è disponibile qui.