Para além de RADIUS e REST, os dados dos subscritores podem ser recuperados a partir de uma série de sistemas de facturação suportados.
As integrações de facturação suportam apenas endereços IPv4.
Aradial
O Aradial utiliza o RADIUS. Ver o capítulo Interface RADIUS.
Azotel
O BQN recupera os dados do balde do cliente e obtém dele os limites de velocidade a aplicar(taxa de carregamento e de descarregamento).
Para activar o Azotel, no GUI BQN vá a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Azotel e active o interruptor.
Também será necessário um utilizador e uma palavra-passe para o acesso REST/JSON à Azotel. Esse utilizador/palavra-passe deve ser criado no sistema Azotel com acesso permitido a partir do endereço IP BQN. Consulte a documentação do Azotel aqui.
O BQN utilizará o seu endereço de gestão para as consultas da Azotel, mas tenha em conta que se o BQN chegar à Azotel através da Internet, a Azotel verá um endereço IP público e é este que necessitará de autorização do sistema Azotel.
Na GUI do BQN, configurar também o endereço IP do sistema Azotel ou nome do servidor e número de porta (443 por padrão).
Os clientes da Azotel com um estado diferente de "actual" serão bloqueados (são considerados como não tendo uma assinatura válida). Pode alterar este comportamento para não bloquear, desactivando o interruptor Block Inactive/Not Paying Subscribers.
As taxas de política são retiradas da taxa de carregamento e da taxa de descarregamento dos campos de balde do cliente.
Com a informação de grupos de assinantes activada, e se a informação estiver disponível na base de dados da Azotel, a alcunha do pai do CPE cliente (por exemplo, um AP) será utilizada como grupo de assinantes, com o prefixo "L1-". Além disso, o nome do site onde se encontra o pai será um grupo de assinantes, com o prefixo "L2-". Assim, haverá dois níveis: um primeiro nível constituído por grupos de assinantes AP (L1) e um segundo nível com sítios (L2), que podem conter um ou mais APs.
Gestfy
O Gestfy utiliza a API REST do BQN. Ver capítulo API REST .
ISPCube
O ISPCube utiliza a API REST do BQN. Ver capítulo API REST .
Consulte aqui as instruções de configuração do lado da faturação do ISPCube (vá ao separador Bequant na parte inferior da página).
ISPSolution
O ISPSolution utiliza a API REST do BQN. Ver capítulo API REST .
Microwisp
O Microwip utiliza o RADIUS. Ver capítulo Interface RADIUS.
Powercode
Para activar o Powercode na GUI BQN, vá a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Powercode e active o interruptor.
Forneça o endereço IP do sistema Powercode ou o nome do servidor e o número da porta SSH (22 por defeito).
O servidor BQN precisa de acesso SSH ao servidor Powercode utilizando uma Unix User/Password.
No sistema Powercode, iremos requerer um utilizador MySQL e uma palavra-passe. Se o utilizador/senha MySQL for diferente do utilizador/senha Unix, isso deverá ser especificado nas Credenciais MySQL no GUI do BQN. O utilizador MySQL deve ter acesso lido às seguintes tabelas da base de dados MySQL Powercode:
- Serviços
- InternetInfo
- Equipamento
- Cliente
- CustomerServices
- AddressRange
Os clientes Powercode com um estado diferente de "Activo" serão bloqueados (considera-se que não têm uma assinatura válida). Pode alterar este comportamento para não bloquear, desactivando o interruptor Bloquear assinantes inactivos/não pagantes.
As taxas de política são retiradas do serviço de apoio ao cliente Internet Info (MaxIn, MaxOut, BurstIn, BurstOut e BurstBucktTime).
Com a informação do grupo de assinantes activada, e se a informação estiver disponível na base de dados do Powercode, o LocationID do equipamento do CPE do cliente será utilizado como grupo de assinantes, prefixado com "L1-".
REST-API Powercode
A facturação por Powercode restringe o REST API a três pedidos por segundo. Por esse motivo, a integração preferida é a utilização do acesso MySQL descrito na secção anterior. O REST-API pode ser utilizado quando o MySQL não pode ser utilizado e o número de subscritores é baixo (mil ou menos).
O BQN recupera equipamento CPE de uma certa categoria (1 por padrão). Para assinantes com essa categoria de equipamento, recuperará os limites das tarifas do seu serviço de Internet ("internetInfo").
Para activar Powercode, ir a Configuração->Dados de Assinante Externo-> Sistemas de Facturação, seleccionar Powercode activar o interruptor.
Será também necessária uma chave API. A chave API deve ser criada no sistema Powercode, com acesso permitido a partir do endereço IP do BQN (o BQN utilizará o seu endereço de gestão para as consultas do Powercode).
Forneça também o endereço IP do sistema Powercode ou o nome do servidor e o número da porta (444 por padrão).
Se a categoria do equipamento CPE na base de dados Powercode for diferente de 1, altere-a. Pode ser especificada mais do que uma categoria, digitando os números de categoria separados por espaços (por exemplo "10 11 12" para as categorias 10, 11 e 12).
Não é possível obter informações sobre o grupo de assinantes; em vez disso, utilize a opção baseada em SQL.
Sonar
O Sonar v2 é suportado (o que tem a API GraphQL).
O BQN recupera as tarifas do cliente e os limites de velocidade a aplicar.
Para activar a integração do Sonar, vá a Configuration->RADIUS/REST/Billing ->Billing Systems no GUI do BQN, seleccione Sonar e active o interruptor.
Será necessária uma chave API. Devem ser criadas no sistema Sonar. Ver a documentação do Sonar para mais detalhes aqui.
Por fim, na GUI do BQN, configure o endereço IP do sistema Sonar ou o nome do servidor e o número da porta (443 por predefinição) em Configuração->RADIUS/REST/Faturação ->Sistemas de faturação, com o Sonar selecionado e ativado.
Por predefinição, os clientes Sonar com o campo account_status->name com um valor diferente de "Ativo" serão bloqueados (são considerados como não tendo uma subscrição válida). Pode adicionar mais estados para além de "Active", para que também não sejam bloqueados (ver exemplo anterior, onde o estado Employee foi adicionado). Pode alterar o comportamento do BQN para não bloquear relativamente ao estado da conta, desactivando a opção Bloquear assinantes inactivos/não pagantes.
Os seguintes campos na faturação do Sonar podem ser utilizados como fonte da ID do assinante:
- Customer-ID (campo de ID da conta no Sonar).
- Nome (nome da conta no Sonar).
Os limites de velocidade são retirados dos campos de pormenor do serviço de dados:
- velocidade_de_descarregamento_kilobits_por_segundo
- upload_speed_kilobits_per_second
Por predefinição, o nome da política de taxas é criado internamente pelo BQN. Em alternativa, se estiver activada a opção de alternar os nomes das políticas a partir dos nomes dos serviços Sonar, as políticas serão nomeadas utilizando o nome do serviço Sonar mais o ID do serviço a ele anexado, de modo a ter um identificador único (os nomes dos serviços Sonar por si só não têm garantia de serem únicos).
Com a informação do grupo de subscritores activada, e se a informação estiver disponível na base de dados do Sonar, será criado um grupo de subscritores, prefixado com "L1-", com base na descrição do item de inventário principal do item de inventário do subscritor.
Splynx
O BQN recupera as tarifas do cliente, os limites de velocidade a aplicar e as taxas de rebentamento, juntamente com os limiares de rebentamento e a duração do rebentamento.
Para activar o Splynx na GUI BQN, vá a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Splynx e active o interruptor.
Será necessária uma chave API e um segredo. Devem ser criadas no sistema Splynx com as seguintes configurações:
- Habilitar a autorização básica para esta chave.
- Deixar em branco Allowed list for IPs ou incluir o endereço IP BQN. O BQN utilizará o seu endereço de gestão para consultas Splynx mas tenha em conta que se o BQN chegar ao Splynx pela Internet, o Splynx verá um endereço IP público e este é o que necessitará de autorização do sistema Splynx.
- Adicionar permissões de visualização para itens da base de dados Planos tarifários ->Internet e Clientes->Clientes online.
As seguintes capturas de ecrã mostram a CHAVE API e as permissões de acesso:
Na GUI do BQN, configurar também o endereço IP do sistema Splynx ou nome do servidor e número de porta (443 por padrão).
Os clientes Splynx com "1" no seu campo de bloqueio serão bloqueados (considera-se que não têm uma subscrição válida). Pode alterar este comportamento para não bloquear, desactivando a opção Bloquear assinantes inactivos/não pagantes.
Os limites de velocidade da política tarifária são retirados da tarifa Internet associada ao cliente em linha:
- seed_download
- speed_upload
Não é possível recuperar a informação do grupo de assinantes, uma vez que não existe um campo normalizado no sistema de faturação com essa informação.
UISP
Existe um plug-in de código aberto disponível no github. É apoiado pela comunidade (sem apoio oficial). Utiliza a API REST do BQN.
Instalação
Pré-requisitos
- BQN com os pacotes linux-R3.0.13-2-20231130 ou posterior e bqn-R4.18.8 ou posterior.
- BQN com a API REST activada (ver https://www.bequant.com/docs/rest#rest-configuration).
- UISP com API REST activada com acesso aoNMS e ao CRM. Deve ser criada uma API KEY comum para ambos os tipos de acesso.
Passos
- Vá ao repositório de código e obtenha o ficheiro zip do código (na página inicial do repositório, vá a Code->Download ZIP).
- Descompacte o ficheiro zip do código. Por exemplo, com o comando unzip:
Isto irá criar um subdiretório chamado uisp-main.
- Criar um diretório uisp na conta de raiz do servidor BQN:
Where <BQN-OAM-IP> is the management IP address of the BQN server.
- Edite o ficheiro sync-uisp-bqn.sh para definir os parâmetros para os valores do seu ambiente. Exemplo:
- Transfira os seguintes ficheiros do PC para o servidor BQN utilizando scp:
- No BQN, copie sync-uisp-bqn.sh para o diretório crontab para que seja executado a cada 5 minutos:
E é tudo, o script acederá ao UISP de 5 em 5 minutos e actualizará o BQN em conformidade. Pode verificar o registo do script no BQN:
Para ver as políticas e os assinantes criados no servidor BQN, consulte a secção "Verificar a API REST" em https://www.bequant.com/docs/rest#rest-configuration.
Actualizações
Para atualizar o script de sincronização, faça o seguinte:
- Vá ao repositório de código e obtenha o ficheiro zip do código (na página inicial do repositório, vá a Code->Download ZIP).
- Descompacte o ficheiro zip do código. Por exemplo, com o comando unzip:
Isto irá criar um subdiretório chamado uisp-main.
- Transfira os seguintes ficheiros do PC para o servidor BQN utilizando scp:
Where <BQN-OAM-IP> is the management IP address of the BQN server. NOTE that the sync-uisp-bqn.sh MUST NOT be updated.
Limitações conhecidas
- A primeira vez pode demorar minutos a ser executada. As execuções seguintes enviarão ao BQN apenas as alterações do cliente e serão mais rápidas.
- Se a sincronização falhar, não é tentada qualquer nova tentativa até à próxima tarefa agendada.
Visp.net
O BQN recupera a tarifa do cliente e obtém dela os limites de velocidade a aplicar e as taxas de rebentamento, limiares e duração.
Para activar Visp, ir a Configuration->RADIUS/REST/Billing ->Billing Systems, seleccionar Visp e activar o interruptor.
Deve ser fornecido ao BQN um ID de cliente válido e um nome de utilizador e uma palavra-passe para solicitar os tokens API temporais. Um identificador de cliente é único por instalação Visp. Um utilizador é qualquer uma das contas de utilizador válidas nesse cliente para aceder ao sistema.
The provided IP address or server name will be used, along with the port (443 by default), to requests API tokens (https://<server>:<port>/token) and also to send API queries (https://<server>:<port>/graphql).
O ecrã seguinte mostra um exemplo de configuração Visp:
Os clientes Visp com um estado de pacote e de instância de serviço diferente de ACTIVE serão bloqueados. É possível alterar este comportamento para não bloquear, desactivando a opção Block Inactive/Not PayingSubscribers.
Com a opção Bloquear assinantes inactivos/não pagantes activada, o BQN bloqueará os assinantes com base em dois critérios possíveis:
- Estado das instâncias de serviço e dos pacotes (por defeito). Se nenhum deles estiver no estado "ACTIVE", o assinante será bloqueado.
- Estado da conta de assinante. Se esta opção for escolhida, os assinantes nos estados Suspenso, Hibernado e Inativo serão bloqueados (códigos de estado 8, 9 e 10, respetivamente).
Os seguintes campos da faturação Visp podem ser utilizados como fonte do ID de assinante:
- Identificação do cliente
- Nome + Apelido
- Nome de utilizador
As taxas de política são obtidas a partir das instâncias de serviço do cliente up_speed e down_speed. As taxas de rutura up_burst e down_burst também são obtidas.
Com a informação do grupo de assinantes activada, o identificador do ponto de acesso associado ao CPE do assinante, com prefixo "L1-", será o nome do grupo de assinantes, caso a informação esteja disponível na base de dados Visp.
WISPControlo
O WISPControl utiliza o RADIUS. Ver o capítulo Interface RADIUS.
Wisphub
O Wisphub desenvolveu uma integração com o BQN utilizando a API REST do BQN. Consulte a documentação do produto Wisphub aqui.
Wispro
O BQN recupera clientes, contratos e planos para que os limites de velocidade sejam aplicados.
Para ativar o Visp, vá a Configuração->RADIUS/REST/Billing->Sistemas de faturação, seleccione Wispro e active o interrutor.
Deve ser fornecida uma chave API válida. A chave API deve ser gerada no sistema Wispro. Ver instruções aqui.
The provided IP address or server name will be used, along with the port (443 by default), to send API queries to Wispro (https://<server>:<port>/api/v1).
O ecrã seguinte mostra um exemplo de configuração do Wispro:
Apenas os clientes Wispro com contratos em estado desativado serão bloqueados. É possível alterar este comportamento para não bloquear, desactivando a opção Bloquear Assinantes Inactivos/Não Pagantes.
Os seguintes campos da faturação Wispro podem ser utilizados como fonte da identificação do assinante:
- SubscriberID ("public_id" no cliente Wispro).
- Nome.
- Endereço MAC.
- Início de sessão (campo "email" no cliente Wispro).
As taxas da política são retiradas do plano do contrato do cliente. Os parâmetros ceil_down_kbps e ceil_up_kbps do plano são utilizados como limites de velocidade.
Se um cliente Wispro tiver mais de um contrato, a cada endereço IP serão atribuídos os limites de velocidade do seu contrato. Se um endereço IP se repetir em dois contratos de cliente (trata-se de uma incoerência na base de dados de faturação que não deveria acontecer), serão seleccionados os limites do contacto obtido em último lugar.
Com a informação do grupo de subscritores activada, os nomes dos nós serão utilizados como grupos de subscritores, ou seja, um subscritor será associado a um grupo de subscritores após o nome do nó do contrato, se essa informação estiver disponível na base de dados Wispro.
Considerações gerais sobre a faturação
Fonte de ID do assinante
O sistema de faturação pode ser a fonte de IDs de assinantes BQN. As opções de fontes de ID dependem do sistema de faturação (ver detalhes em cada secção de faturação).
Para os sistemas de faturação integrados através da API REST, o sistema de faturação tem o controlo total do ID do assinante, que pode ser explicitamente definido ao criar ou editar o assinante.
Bloquear subscritores inactivos/não pagantes
Por defeito, o BQN bloqueia os assinantes que não pagam. O que é um assinante não pagante depende do sistema de faturação (consulte cada secção específica de faturação para obter detalhes). Para evitar que o BQN bloqueie os assinantes não pagantes, desative a opção Bloquear Assinantes Inativos/Não Pagantes.
No caso dos sistemas de faturação integrados através da API REST, o sistema de faturação tem o controlo total da definição do limite de débito e pode bloquear um assinante atribuindo-lhe uma política com velocidade limite de débito 0.
Fator de escala da taxa
Por defeito, o BQN aplicará os limites de taxa conforme especificado pelo sistema de faturação. É possível aplicar um fator de escala a esses limites utilizando o campo Escala do limite de taxa.
Para impor um limite de velocidade inferior ao da faturação, utilize um fator inferior a 100%. Por exemplo, um limite na faturação de 200 Mbps com um fator de 90% será de 180 Mbps.
Para impor uma velocidade superior à da faturação, utilize um fator superior a 100 % e até 200% (fator máximo possível). Por exemplo, uma velocidade de 200 Mbps na faturação com um fator de 150% será de 300 Mbps.
Para os sistemas de faturação integrados através da API REST, o sistema de faturação tem o controlo total da definição do limite da tarifa e pode decidir qual o fator, se for caso disso, que se aplica aos limites enviados para o BQN.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique. Duis cursus, mi quis viverra ornare, eros dolor interdum nulla, ut commodo diam libero vitae erat. Aenean faucibus nibh et justo cursus id rutrum lorem imperdiet. Nunc ut sem vitae risus tristique posuere.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique. Duis cursus, mi quis viverra ornare, eros dolor interdum nulla, ut commodo diam libero vitae erat. Aenean faucibus nibh et justo cursus id rutrum lorem imperdiet. Nunc ut sem vitae risus tristique posuere.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique. Duis cursus, mi quis viverra ornare, eros dolor interdum nulla, ut commodo diam libero vitae erat. Aenean faucibus nibh et justo cursus id rutrum lorem imperdiet. Nunc ut sem vitae risus tristique posuere.