Como trabalhar com a API do BILLmanager

A API é uma interface de software que permite controlar qualquer aplicação através de um conjunto de comandos e funções. Por exemplo, existe a API Yandex Music, graças à qual é possível ouvir faixas de música no sítio. No nosso trabalho, utilizamos o sistema de faturação BILLmanager.

Tem a sua própria API, com a ajuda da qual é possível escalar servidores com tarifas flexíveis, obter informações sobre pagamentos e débitos de contas. Regra geral, qualquer programador de API dispõe de documentação detalhada no seu sítio Web sobre a forma de instalar e configurar a interface do software.

No entanto, a documentação da API do BILLmanager é difícil de dominar. Se quiser tornar-se um profissional no trabalho com a API, então é altura de começar a estudar a documentação. Se o mais importante para si é completar a tarefa e obter o resultado num curto período de tempo, basta utilizar as instruções abaixo.

Lista de parâmetros

Uma das primeiras perguntas que surgem quando se trabalha com a API do BILLmanager é onde obter a lista de parâmetros? Todos os parâmetros para trabalhar com o BILLmanager podem ser encontrados na documentação do programador. A lista completa dos parâmetros de trabalho pode ser consultada através desta hiperligação.

Como obter a lista de VDS

Para obter a lista de VDS, é necessário efetuar um pedido para o seguinte URL:

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

Parâmetros no pedido:

• authinfo - dados de autorização na faturação;
• func - função executada na faturação;
• out - formato de saída dos dados, são suportados xml, json e JSONdata.

Em todos os pedidos, é necessário utilizar os seus dados pessoais, por isso, altere username:password para o seu nome de utilizador e palavra-passe e, em seguida, faça um pedido GET, por exemplo, utilizando CURL.

Como encomendar VDS

Para encomendar um VDS, é necessário efetuar um pedido para o seguinte 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 no pedido:

• authinfo - dados de autorização na faturação;
• func - função executada na faturação;
• addon_X -addon a encomendar (opcional), por exemplo, para encomendar painel de controlo ou endereços IPv6;
• autoprolong - opção para ativar ou desativar a renovação automática do servidor;
• ostempl - modelo de SO para a encomenda;
• period - período da encomenda, o número de meses é especificado, são suportados 1, 3, 6, 12;
• pricelist - ID do plano tarifário;
• skipbasket - sinalizador para saltar a fase de colocação do cesto de compras, para encomenda automática do serviço;
• domínio - nome dodomínio do servidor (opcional);
• sok - confirmação do pedido.

Alteração dos parâmetros do servidor

API para alterar os parâmetros do servidor virtual:

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

Para alterar os parâmetros do 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 no pedido:

• authinfo - dados de autorização na faturação;
• func - função executada na faturação;
• elid - código de serviço;
• addon_X -addon a alterar (opcional), por exemplo, para alterar o número de endereços IP;
• domain - nome do domínio (opcional);
• sok - confirmação do pedido.

Os acréscimos ao plano tarifário aquando da encomenda ou alteração de um serviço via API são passados através do parâmetro addon_, que assume o valor addon_5=10, em que 5 é o código do acréscimo, 10 é o valor.

Ao fazer pedidos de API, pode utilizar a consola do navegador, no separador "rede" pode ver quais os pedidos feitos a partir do navegador ao encomendar um servidor, os mesmos parâmetros podem ser passados através de pedidos de API. A lista acima descreve exemplos de pedidos de API, com uma lista incompleta de funções e parâmetros.

Trabalhar com ciclos

Se precisar de remover VDS, adicionar memória ou núcleos de processador, pode fazê-lo sem a API do BILLmanager. No entanto, em caso de encomenda de 10, 100 VDS ou de alteração em massa dos parâmetros do servidor, este processo pode demorar várias horas. É habitual utilizar ciclos para estes 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

O exemplo utiliza o pedido de encomenda de servidor da API, o seq especifica o número de servidores a encomendar. Os parâmetros de encomenda do servidor são semelhantes à encomenda de um único servidor sem utilizar ciclos.

A documentação completa sobre o trabalho com a API BILLmanager do programador está disponível aqui.