Cómo trabajar con la API de BILLmanager

API es una interfaz de software que permite controlar cualquier aplicación a través de un conjunto de comandos y funciones. Por ejemplo, existe la API de Yandex Music, gracias a la cual se pueden escuchar pistas de música en el sitio. En nuestro trabajo, utilizamos el sistema de facturación BILLmanager.

Tiene su propia API, con ayuda de la cual puedes escalar servidores a tarifas flexibles, obtener información sobre pagos y débitos en cuenta. Por regla general, cualquier desarrollador de API dispone de documentación detallada en su sitio web sobre cómo instalar y configurar la interfaz del software.

Sin embargo, la documentación de la API de BILLmanager es difícil de dominar. Si desea convertirse en un profesional en el trabajo con la API, entonces es el momento de empezar a estudiar la documentación. Si lo principal para usted es completar la tarea y obtener el resultado en un corto periodo de tiempo, es suficiente con utilizar las siguientes instrucciones.

Lista de parámetros

Una de las primeras preguntas que surgen al trabajar con la API de BILLmanager es dónde obtener la lista de parámetros. Todos los parámetros para trabajar con BILLmanager se pueden encontrar en la documentación del desarrollador. La lista completa de parámetros de trabajo se puede encontrar siguiendo este enlace.

Cómo obtener la lista de VDS

Para obtener la lista de VDS, es necesario hacer una petición a la siguiente URL:

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

Parámetros de la solicitud:

• authinfo - datos de autorización en facturación;
• func - función ejecutada en facturación;
• out - formato de salida de los datos, se admiten xml, json y JSONdata.

En todas las solicitudes debe utilizar sus datos personales, así que cambie username:password por su nombre de usuario y contraseña y, a continuación, realice una solicitud GET, por ejemplo, utilizando CURL.

Cómo solicitar un VDS

Para pedir un VDS, tiene que hacer una petición a la siguiente 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

Parámetros de la solicitud:

• authinfo - datos de autorización en facturación;
• func - función ejecutada en facturación;
• addon_X - addon a solicitar (opcional), por ejemplo, para solicitar panel de control o direcciones IPv6;
• autoprolong - opción para activar o desactivar la renovación automática del servidor;
• ostempl - plantilla de SO para el pedido;
• period - periodo del pedido, se especifica el número de meses, se admiten 1, 3, 6, 12;
• pricelist - ID del plan de tarifas;
• skipbasket - indicador de omisión de la etapa de pago de la cesta de la compra, para el pedido automático del servicio;
• domain - nombre dedominio del servidor (opcional);
• sok - confirmación de la solicitud.

Modificación de los parámetros del servidor

API para cambiar los parámetros del servidor virtual:

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

Para cambiar los parámetros del servidor dedicado:

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

Parámetros en la solicitud:

• authinfo - datos de autorización en facturación;
• func - función ejecutada en facturación;
• elid - código de servicio;
• addon_X - addon a cambiar (opcional), por ejemplo, para cambiar el número de direcciones IP;
• domain - nombre de dominio (opcional);
• sok - solicitud de confirmación.

Las adiciones al plan de tarifas al solicitar o cambiar un servicio a través de API se pasan a través del parámetro addon_, que toma el valor addon_5=10, donde 5 es el código de la adición, 10 es el valor.

Al hacer peticiones API puede utilizar la consola del navegador, en la pestaña "red" puede ver qué peticiones se hacen desde el navegador al pedir un servidor, los mismos parámetros se pueden pasar a través de peticiones API. La lista anterior describe ejemplos de peticiones API, con una lista incompleta de funciones y parámetros.

Trabajar con ciclos

Si necesita eliminar VDS, añadir memoria o núcleos de procesador, puede hacerlo sin BILLmanager API. Sin embargo, en caso de solicitar 10, 100 VDS o cambiar en masa los parámetros del servidor, este proceso puede durar varias horas. Es habitual utilizar ciclos para estos casos:

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

El ejemplo utiliza la solicitud de pedido de servidor API, la seq especifica el número de servidores a pedir. Los parámetros de pedido de servidor son similares al pedido de un solo servidor sin utilizar ciclos.

La documentación completa sobre el trabajo con la API BILLmanager del desarrollador está disponible aquí.