L'API est une interface logicielle qui permet de contrôler n'importe quelle application par le biais d'un ensemble de commandes et de fonctions. Par exemple, il existe l'API Yandex Music, grâce à laquelle vous pouvez écouter des morceaux de musique sur le site. Dans notre travail, nous utilisons le système de facturation BILLmanager.
Il possède sa propre API, qui permet d'adapter les serveurs à des tarifs flexibles, d'obtenir des informations sur les paiements et les débits de compte. En règle générale, tout développeur d'API dispose sur son site web d'une documentation détaillée sur l'installation et la configuration de l'interface logicielle.
Cependant, la documentation de l'API de BILLmanager est difficile à maîtriser. Si vous voulez devenir un professionnel en travaillant avec l'API, il est temps de commencer à étudier la documentation. Si l'essentiel pour vous est d'accomplir la tâche et d'obtenir le résultat en peu de temps, il suffit d'utiliser les instructions ci-dessous.
L'une des premières questions que l'on se pose lorsqu'on travaille avec l'API BILLmanager est de savoir où se trouve la liste des paramètres. Tous les paramètres pour travailler avec BILLmanager peuvent être trouvés dans la documentation du développeur. La liste complète des paramètres de travail peut être trouvée en suivant ce lien.
Pour obtenir la liste des SDV, il faut faire une demande à l'URL suivante :
https://bill.pq.hosting/billmgr?func=vds&authinfo=username:password&out=JSONdata
Paramètres de la requête :
authinfo
- données d'autorisation dans la facturation ;func
- fonction exécutée dans la facturation ;out
- format de sortie des données, xml, json et JSONdata sont supportés.Dans toutes les requêtes, vous devez utiliser vos données personnelles. Remplacez donc username:password par votre login et votre mot de passe, puis effectuez une requête GET, par exemple, en utilisant CURL.
Pour commander un SDV, vous devez envoyer une demande à l'URL suivante :
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
Paramètres de la requête :
authinfo
- données d'autorisation dans la facturation ;func
- fonction exécutée dans la facturation ;addon_X
-addon
à commander (facultatif), par exemple pour commander un panneau de contrôle ou des adresses IPv6 ;autoprolong
- option permettant d'activer ou de désactiver le renouvellement automatique du serveur ;ostempl
- modèle de système d'exploitation pour la commande ;period
- période de commande, le nombre de mois est spécifié, 1, 3, 6, 12 sont supportés ; pricelist
- ID du plan tarifaire ;skipbasket
- indicateur permettant de sauter l'étape de la vérification du panier d'achat, pour la commande automatique du service ;domain
- nom dedomaine
du serveur (facultatif) ;sok
- confirmation de la demande.API pour la modification des paramètres des serveurs virtuels :
https://bill.pq.hosting/billmgr?func=vds.edit&authinfo=username:password&addon_11=512&elid=958&domain=company.com&sok=ok
Pour modifier les paramètres d'un serveur dédié :
https://bill.pq.hosting/billmgr?func=dedic.edit&authinfo=username:password&addon_26=10&addon_26=10&addon_28=5000&elid=1065&sok=ok
Paramètres dans la demande :
authinfo
- données d'autorisation dans la facturation ;func
- fonction exécutée dans la facturation ;elid
- code de service ;addon_X
-addon
à modifier (facultatif), par exemple, pour modifier le nombre d'adresses IP ;domain
- nom de domaine (facultatif) ;sok
- confirmation de la demande.Les ajouts au plan tarifaire lors de la commande ou de la modification d'un service via l'API sont transmis par le paramètre addon_
, qui prend la valeur addon_5=10
, où 5
est le code de l'ajout, 10
est la valeur.
Lorsque vous faites des requêtes API, vous pouvez utiliser la console du navigateur, dans l'onglet "réseau", vous pouvez voir quelles requêtes sont faites à partir du navigateur lors de la commande d'un serveur, les mêmes paramètres peuvent être transmis par le biais des requêtes API. La liste ci-dessus décrit des exemples de requêtes API, avec une liste incomplète de fonctions et de paramètres.
Si vous avez besoin de supprimer des SDV, d'ajouter de la mémoire ou des cœurs de processeur, vous pouvez le faire sans l'API de BILLmanager. Cependant, dans le cas de la commande de 10, 100 SDV ou de la modification en masse des paramètres du serveur, ce processus peut prendre plusieurs heures. Il est habituel d'utiliser des cycles pour de tels cas :
#!/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'exemple utilise la demande de commande de serveur API, le seq spécifie le nombre de serveurs à commander. Les paramètres de commande de serveurs sont similaires à ceux de la commande d'un seul serveur sans utiliser de boucles.
Une documentation complète sur l'utilisation de l'API BILLmanager par le développeur est disponible ici.
Apply the discount by inserting the promo code in the special field at checkout: