Documentos BQN

A referência da API REST pode ser encontrada em Guia da API REST da BQN.

‍

Implementação de REST

‍

As políticas de tarifação de assinantes do BQN e a atribuição de assinantes a políticas de tarifação de assinantes podem ser realizadas através de uma API REST, que também pode fornecer métricas de assinantes. Para isso, é claro, o BQN deve visualizar os endereços IP do tráfego de dados dos assinantes, ou seja, não pode haver um NAT entre os assinantes e o BQN, pois os limites do plano serão aplicados para cada endereço IP. Também é importante que o wires esteja conectado corretamente (ou seja, que as portas de rede configuradas como portas de acesso estejam conectadas do lado dos assinantes).

Os endereços IPv4 e IPv6 são ambos suportados. No caso de endereços IPv6, a API REST aplica uma máscara de sub-rede (/64 por padrão) uma vez que todos os endereços da mesma sub-rede são considerados como pertencentes ao mesmo subscritor.

A integração é entre um sistema que controla a definição do plano (por exemplo, um sistema de facturação) e o BQN, através da interface de gestão do BQN. O BQN actua como o servidor REST API. O BQN utiliza o endereço IP de gestão (o mesmo utilizado pelo GUI) para receber as mensagens REST ouvidas na porta TCP 3443 (configurável).

‍

REST Definição e Selecção de Políticas

‍

Através do REST API, são possíveis as seguintes operações políticas:

• Criar políticas de controlo de taxas (os planos de subscrição).
• Atribuir um plano a um subscritor.
• Obter métricas de assinantes até 3 meses: volume utilizado, velocidade máxima, latência, retransmissões, fluxos activos/criados, tráfego com congestionamento e à velocidade máxima, informações DPI, etc.
• Gerir quotas de tempo e de volume.

O diagrama seguinte mostra um exemplo em que são criadas várias políticas e, posteriormente, a cada assinante é atribuída uma dessas políticas.

Existem operações para criar, listar, modificar e eliminar tanto as políticas como as associações de subscritores.

A API REST é descrita em mais detalhe no Guia BQN REST APIque inclui a definição de todos os pedidos possíveis.

‍

Configuração REST

‍

Configurar REST no BQN

‍

1. Para activar o REST API no BQN, vá a Configuration->RADIUS/REST/Billing->REST API e mude o Rest API para On.

2. Acrescentar os endereços IP de todos os clientes REST à configuração BQN. No GUI, vá a Configuração->RADIUS/REST/Billing->REST API e clique em Add Client...

3. Adicionar os utilizadores REST, juntamente com as suas palavras-passe, à configuração do BQN. No GUI, vá a Configuração->RADIUS/REST/Billing->REST API e clique em Add User...

‍

‍

Verificar clientes REST

A integração da API REST requer a programação da API no elemento que interage com o BQN, por exemplo, um sistema de facturação. Para testar se a configuração REST do BQN está correcta, as mensagens REST podem ser enviadas manualmente utilizando o utilitário curl Linux.

Por exemplo, para criar uma política com o nome my_rest_policy_1 e atribuí-la a um assinante com o IP 10.10.1.232:

curl -i -k -m 20 -u myuser:mypassword -X POST https://192.168.0.121:3443/api/v1/policies/rate/my_rest_policy_1 -H"Content-Type: application/json" --data '{"rateLimitDownlink": {"rate": 1000,"burstRate": 2000}, "rateLimitUplink": {"rate":500, "burstRate": 1000}}'

Verifique a API REST

‍

Uma vez criadas as políticas e as associações de assinantes, a tabela Status->Políticas->Políticas de Tarifa mostrará as políticas provenientes do REST. Por exemplo, a tabela seguinte mostra três políticas, com assinantes provisionados que também estão activos (com tráfego):

Para ver a lista de assinantes com políticas REST, seleccione Estado->Subscritores->Atributos dos assinantes. O próximo exemplo mostra dez assinantes e suas políticas associadas:

‍

Se for necessário um certificado digital no BQN

‍

Por vezes, os clientes REST precisam de um certificado digital específico para validar o acesso.

Iniciar sessão como root na shell Unix da BQN.

Procure os seguintes directórios:

 
/bqn/root/etc/ssl/certs
/bqn/root/etc/ssl/private

‍

Se os directórios não existirem, crie-os:

bqn:~ # mkdir -p /bqn/root/etc/ssl/certs/
bqn:~ # mkdir -p /bqn/root/etc/ssl/private/
bqn:~ # chmod 700 /bqn/root/etc/ssl/private/

‍

Copie o certificado e a respectiva chave para os seguintes ficheiros:

 
/bqn/root/etc/ssl/certs/bqn.crt
/bqn/root/etc/ssl/private/bqn.key

(pode utilizar o scp para transferir previamente os ficheiros do certificado para o servidor BQN).

‍

Para aplicar a alteração, reiniciar o servidor BQN em Administração->Reboot.