Documentación de BQN

Además de RADIUS y REST, los datos del suscriptor se pueden recuperar de varios sistemas de facturación compatibles.

Las integraciones de facturación solo admiten direcciones IPv4, a menos que se indique lo contrario.

‍

Aradial

‍

Aradial utiliza RADIUS. Consulte el capítulo Interfaz RADIUS.

‍

Azotel

‍

El BQN recupera los datos del bucket del cliente y obtiene de él los límites de velocidad a aplicar (uploadrate y downloadrate).

Para activar Azotel, en la GUI de BQN, vaya a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Azotel y active el conmutador.

También se necesitará un usuario y una contraseña para el acceso REST/JSON a Azotel. Ese usuario/contraseña debe crearse en el sistema Azotel con acceso permitido desde la dirección IP de BQN. Consulte la documentación de Azotel aquí.

El BQN utilizará su dirección de gestión para las consultas de Azotel, pero tenga en cuenta que si el BQN llega a Azotel a través de Internet, Azotel verá una dirección IP pública y esta es la que necesitará autorización por parte del sistema Azotel.

En la GUI de BQN, configure también la dirección IP del sistema Azotel o el nombre del servidor y el número de puerto (443 por defecto).

Los clientes de Azotel con un estado diferente a “current” serán bloqueados (se considera que no tienen una suscripción válida). Puede cambiar este comportamiento a no bloqueante desactivando el interruptor Block Inactive/Not Paying Subscribers.

Las velocidades de la política se toman de los campos de bucket del cliente: velocidad de carga y velocidad de descarga.

Con la información del grupo de suscriptores habilitada, y si la información está disponible en la base de datos de Azotel, el apodo del padre del CPE del cliente (por ejemplo, un AP) se utilizará como un grupo de suscriptores, con el prefijo “L1-“. Además, el nombre del sitio donde se encuentra el padre será un grupo de suscriptores, con el prefijo “L2-“. Por lo tanto, habrá dos niveles: un primer nivel compuesto por grupos de suscriptores de AP (L1) y un segundo con sitios (L2), que pueden contener uno o más AP.

‍

Gaiia

‍

El BQN recupera los límites de velocidad a aplicar de los productos con tipo INTERNET_PLAN. Esos productos tienen campos downloadSpeedInKbps y uploadSpeedInKbps como parte de su rawSpecificationValue,

Se necesitará una clave de API REST en Gaiia. En Gaiia, vaya a Configuración->Claves API, haga clic en Nueva clave API y seleccione los permisos para el acceso a Cuentas y Productos.

Para activar Gaiia, vaya a Configuración->RADIUS/REST/Facturación->Sistemas de facturación, seleccione Gaiia y active el interruptor.

Proporcione también el nombre del servidor Gaiia y el número de puerto (443 por defecto).

Las cuentas de Gaiia en estado de tipo INACTIVO o SUSPENDIDO serán bloqueadas. Puede cambiar este comportamiento a no bloqueo desactivando el interruptor Bloquear suscriptores inactivos/que no pagan.

Los siguientes campos en la facturación de Gaiia pueden utilizarse como fuente del ID de suscriptor:

• ID de cliente: campo readableId de la cuenta.
• Nombre: primaryContact de la cuenta  firstName +lastName

La tarifa de la política se toma del nombre del producto más reciente que se encuentra en el campo billingSubscriptions de la cuenta.

 Los grupos de suscriptores se pueden generar en función del inventoryItem de la cuenta. Si el elemento tiene un upstreamDevice con un assignee, se creará un grupo con el prefijo “L1-“ y el nombre del cesionario. La generación de estos grupos está desactivada por defecto, para activarla, seleccione el interruptor Crear subgrupos con el dispositivo ascendente del elemento de inventario.

‍

La integración de Gaiia está preparada para soportar grupos de doble pila IPv4/IPv6, una vez que esa información esté disponible en Gaiia.

‍

Gestfy

‍

Gestfy utiliza la API REST de BQN. Consulte el capítulo API REST.

‍

HubSoft

‍

HubSoft utiliza la API REST de BQN. Consulte el capítulo API REST.

‍

ISPCube

‍

ISPCube utiliza la API REST de BQN. Consulte el capítulo API REST.

‍

Consulte aquí las instrucciones de configuración en el lado de facturación de ISPCube (vaya a la pestaña Bequant en la parte inferior de la página).

‍

ISP Gestión

ISP Gestión utiliza la API REST de BQN. Consulte el capítulo API REST.

El sistema recuperará métricas del suscriptor como latencia, retransmisión, DPI o la política aplicada en el BQN. No participa en la asignación de políticas, que debe realizarse mediante otro mecanismo (por ejemplo, RADIUS).

‍

‍

ISPSolution

‍

ISPSolution utiliza la API REST de BQN. Consulte el capítulo API REST.

‍

IXC

‍

Tenemos scripts disponibles para sincronizar políticas con IPs de suscriptores utilizando IXC y la API REST de BQN. Póngase en contacto con support@bequant.com para configurarlo en su sistema.

‍

Mikrowisp

‍

Mikrowisp utiliza RADIUS. Consulte el capítulo RADIUS.

‍

Phicus

‍

Tenemos scripts disponibles para sincronizar políticas, nombres de CPE e IPs de suscriptores utilizando las API REST de Phicus y BQN. Póngase en contacto con support@bequant.com para configurarlo en su sistema.

‍

Powercode

‍

Para activar Powercode en la GUI de BQN, vaya a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Powercode y active el conmutador.

Proporcione la dirección IP del sistema Powercode o el nombre del servidor y su número de puerto SSH (22 por defecto).

El servidor BQN necesita acceso SSH al servidor Powercode utilizando un usuario/contraseña de Unix.

En el sistema Powercode, necesitaremos un usuario y una contraseña de MySQL. Si el usuario/contraseña de MySQL es diferente al usuario/contraseña de Unix, debe especificarse en MySQL Credentials en la GUI de BQN. El usuario de MySQL debe tener acceso de lectura a las siguientes tablas de la base de datos MySQL de Powercode:

• Servicios
• InternetInfo
• Equipo
• Cliente
• Servicios al Cliente
• Rango de Direcciones
• DeviceCategory

El BQN recupera el equipo CPE de una determinada categoría (todas las categorías por defecto). Las categorías se especifican como una lista de números separados por espacios. La lista de categorías es la siguiente:

1. CPE
2. Puente CPE
3. Router
4. Servidor
5. Punto de acceso
6. Puente
7. VOIP ATA
8. Backhaul
9. Switch
10. Sensor
11. Equipo propiedad del cliente
12. SAI
13. Otro
14. Router del cliente
15. Switch Netonix
16. BMU
17. Routers CnPilot
18. Controladores solares
19. ONT

Los clientes de Powercode con un estado diferente a “Active” serán bloqueados (se considera que no tienen una suscripción válida). Puede cambiar este comportamiento a no bloqueante desactivando el interruptor Block Inactive/Not Paying Subscribers.

Las tarifas de política se toman de la información de Internet del servicio al cliente (MaxIn, MaxOut, BurstIn, BurstOut y BurstBucktTime).

Con la información del grupo de suscriptores habilitada, y si la información está disponible en la base de datos de Powercode, el LocationID del equipo del CPE del cliente se utilizará como un grupo de suscriptores, con el prefijo “L1-“.

‍

REST-API Powercode

‍

La facturación de Powercode restringe la API REST a tres solicitudes por segundo. Por esta razón, la integración preferida es el uso del acceso MySQL descrito en la sección anterior. La API REST se puede utilizar cuando no se puede utilizar MySQL y el número de suscriptores es bajo (mil o menos).

El BQN recupera el equipo CPE de una determinada categoría (1 por defecto). Para los suscriptores con esa categoría de equipo, recuperará los límites de velocidad de su servicio de Internet (“internetInfo”).

Para activar Powercode, vaya a Configuration->External Subscriber Data->Billing Systems, seleccione Powercode y active el interruptor.

También se necesitará una clave API. La clave API debe crearse en el sistema Powercode, con acceso permitido desde la dirección IP de BQN (el BQN utilizará su dirección de gestión para las consultas de Powercode).

Proporcione también la dirección IP del sistema Powercode o el nombre del servidor y el número de puerto (444 por defecto).

Si la categoría del equipo CPE en la base de datos de Powercode es diferente de 1, cámbiela. Se puede especificar más de una categoría escribiendo los números de categoría separados por espacios (p. ej., “10 11 12” para las categorías 10, 11 y 12).

No es posible recuperar la información del grupo de suscriptores, utilice la opción basada en SQL en su lugar.

‍

Sonar

‍

Se admite Sonar v2 (el que tiene la API GraphQL).

El BQN recupera las tarifas del cliente y los límites de velocidad que se deben aplicar.

Para activar la integración de Sonar, vaya a Configuración->RADIUS/REST/Facturación ->Sistemas de facturación en la GUI del BQN, seleccione Sonar y active el interruptor.

Se necesitará una clave API. Deben crearse en el sistema Sonar. Consulte la documentación de Sonar para obtener más detalles aquí.

Finalmente, en la GUI de BQN, configure la dirección IP del sistema Sonar o el nombre del servidor y el número de puerto (443 por defecto) en Configuración->RADIUS/REST/Facturación ->Sistemas de Facturación, con Sonar seleccionado y habilitado.

De forma predeterminada, los clientes de Sonar con el campo account_status->name con un valor distinto de “Active” se bloquearán (se consideran que carecen de una suscripción válida). Puede agregar más estados además de “Active”, para que tampoco se bloqueen (vea el ejemplo anterior, donde se ha agregado el estado Employee). Puede cambiar el comportamiento de BQN a no bloquear independientemente del estado de la cuenta desactivando el interruptor Bloquear Suscriptores Inactivos/Que No Pagan.

Los siguientes campos en la facturación de Sonar se pueden utilizar como fuente del ID de suscriptor:

• Customer-ID (campo ID de cuenta en Sonar).
• Name (nombre de la cuenta en Sonar).

Los límites de velocidad se toman de los campos de detalle del servicio de datos:

• download_speed_kilobits_per_second
• upload_speed_kilobits_per_second

‍

Por defecto, el nombre de la política de velocidad se crea internamente por el BQN. Alternativamente, si está habilitado el interruptor Policy names from Sonar service names, las políticas se nombrarán utilizando el nombre del servicio Sonar más el Id del servicio añadido a él, con el fin de tener un identificador único (no se garantiza que los nombres de los servicios Sonar por sí solos sean únicos).

Con la información del grupo de suscriptores habilitada, y si la información está disponible en la base de datos de Sonar, se creará un grupo de suscriptores, con el prefijo “L1-“, basado en la descripción del elemento de inventario principal del elemento de inventario del suscriptor.

Se admite la doble pila: para cada cuenta con una dirección IPv4 e IPv6, se aplicará una política de velocidad conjunta. Esto se implementa creando un grupo de suscriptores con esas direcciones como miembros. Para habilitar la doble pila, seleccione un nombre de grupo en el IPv6 dual-stack group name field. Los grupos tendrán un prefijo “DS-“. La creación de grupos de doble pila está desactivada por defecto (vacío IPv6 dual-stack group name). Si, además de la dirección del router del suscriptor, la dirección IP del módulo de suscriptor también aparece en la asignación de IP de la cuenta, también se añadirá al grupo.

Splynx

‍

El BQN recupera las tarifas del cliente, los límites de velocidad a aplicar y las tasas de ráfaga, junto con los umbrales de ráfaga y la duración de la ráfaga.

Para activar Splynx en la GUI del BQN, vaya a Configuración->RADIUS/REST/Facturación->Sistemas de facturación, seleccione Splynx y active el interruptor.

Se necesitará una clave API y un secreto. Deben crearse en el sistema Splynx con la siguiente configuración:

• Habilite la autorización básica para esta clave.
• Deje vacía la Lista de permitidos para IPs o incluya la dirección IP de BQN. El BQN utilizará su dirección de administración para las consultas de Splynx, pero tenga en cuenta que si el BQN llega a Splynx a través de Internet, Splynx verá una dirección IP pública y esta es la que necesitará autorización por parte del sistema Splynx.
• Añada permisos de visualización para los elementos de la base de datos (véase más abajo).

Los elementos de la base de datos que necesitan permisos de visualización en Splynx son:

• ‍Tariff plans->Internet
• ‍Customers->Customer
• ‍Customers->Customers online
• Networking->Network Sites

Las siguientes capturas de pantalla muestran la CLAVE API y los permisos de acceso:

En la GUI del BQN, configure también la dirección IP del sistema Splynx o el nombre del servidor y el número de puerto (443 de forma predeterminada).

Los clientes de Splynx con “1” en su campo blocked , serán bloqueados (se considera que no tienen una suscripción válida). Puede cambiar este comportamiento a no bloqueante desactivando el interruptor Block Inactive/Not Paying Subscribers.

Los siguientes campos en la facturación de Splynx se pueden utilizar como fuente del ID del suscriptor:

• customer_id
• login
• username_real

Los límites de velocidad de la política de velocidad se toman de la tarifa de Internet asociada al cliente en línea:

• seed_download
• speed_upload

Se admite la doble pila: para cada cuenta con una dirección IPv4 e IPv6, se aplicará una política de velocidad conjunta. Esto se implementa creando un grupo de suscriptores con esas direcciones como miembros. Para habilitar la doble pila, seleccione un nombre de grupo en el IPv6 dual-stack group name field. Los grupos tendrán un prefijo “DS-“. La creación de grupos de doble pila está desactivada por defecto (vacío IPv6 dual-stack group name).

El BQN puede crear grupos de suscriptores basados en la información de ubicación de Splynx. La información de ubicación puede ser:

• Grupos basados en el sitio de la red del cliente. Los sitios de red deben definirse en Splynx Redes->Sitios de red y asociarse con cada cliente utilizando el campo Ubicación en Información principal del cliente.
• Grupos basados en etiquetas de cliente. Las etiquetas se crean en Configuración->Sistema->Etiquetas y se asocian con cada cliente utilizando el campo Etiquetas en Información adicional del cliente.

La generación de estos grupos está desactivada por defecto, para activarla, seleccione una de las opciones en Crear subgrupos (Sitios de red, Etiquetas o ambos).

‍

UISP

‍

En primer lugar, se debe conceder acceso de lectura tanto a las partes UCRM como a las UNMS del sistema UISP.

La siguiente captura de pantalla muestra dónde crear el API KEY en el subsistema Ubiquiti NMS.

‍

Antes de la aplicación UISP 2.4.220, se podía crear una API Key común en NMS para acceder también a CRM. A partir de la aplicación UISP 2.4.220, se deben crear dos API Keys, una para acceder a NMS y otra para acceder a CRM en CRM System -> Security ->App Keys‍

Vea en la siguiente captura de pantalla dónde crear una API KEY en el subsistema CRM:

Para activar UISP, vaya a Configuración->RADIUS/REST/Facturación->Sistemas de facturación, seleccione UISP y active el interruptor.

Especifique las claves API. Si utiliza una aplicación UISP anterior a la 2.4.220, rellene cualquiera de los dos campos API KEY (el otro tomará el mismo valor).

Especifique el nombre del servidor o la dirección IP en el campo Servidor y el número de puerto (443 por defecto).

Las políticas de tarifas se recuperarán de los planes de servicio UCRM cuyo servicePlanType sea "Internet".

Los suscriptores se obtienen de los clientes de UCRM.

Los ID de suscriptor pueden tener tres fuentes, seleccionables en Fuente de ID de suscriptor:

• ID de cliente: del campo “id” del cliente.
• Nombre: del formulario del cliente "firstName" y "lastName" (y si ambos son nulos, "companyName").
• Inicio de sesión: del nombre de usuario del cliente.

Un suscriptor está asociado con una política de tarifas a través de los servicios al cliente. Los servicios están asociados con direcciones IP a través de los dispositivos en la parte UNMS del sistema UISP.

Un servicio con un estado diferente a “Activo” o “Suspendido” tendrá el tráfico de sus direcciones IP asociadas bloqueado, a menos que Bloquear suscriptores inactivos/que no pagan esté desactivado.

Los grupos de suscriptores se extraen de la siguiente manera:

• Los dispositivos con un campo “apDevice” se agrupan bajo ese AP (el tipo de grupo de suscriptores será el de punto de acceso). Esto normalmente funcionará para los puntos de acceso de Ubiquiti.
• Los dispositivos con un sitio principal se agruparán bajo ese sitio (el tipo de grupo de suscriptores será torre).

UISP no es compatible con IPv6 en este momento.

 NOTA: esta integración reemplaza los scripts de python de código abierto anteriores.

Vision por Fibersmith

‍

Vision ha desarrollado una integración con BQN utilizando la API REST de BQN. Consulte el capítulo API REST.

‍

Visp.net

‍

El BQN recupera la tarifa del cliente y obtiene de ella los límites de velocidad a aplicar y las tasas, los umbrales y la duración de la ráfaga.

Para activar Visp, vaya a Configuración->RADIUS/REST/Facturación ->Sistemas de facturación, seleccione Visp y active el interruptor.

Se debe proporcionar un ID de cliente y una clave secreta, así como un nombre de usuario y una contraseña válidos al BQN para solicitar tokens API temporales. Un ID de cliente es único por cada instalación de Visp. Un usuario es cualquiera de las cuentas de usuario válidas en ese cliente para acceder al 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).  

La siguiente pantalla muestra un ejemplo de configuración de Visp:

Los clientes de Visp con un estado de paquete y un estado de instancia de servicio que no sea ACTIVO, serán bloqueados. Puede cambiar este comportamiento a no bloqueante desactivando el interruptor Bloquear suscriptores inactivos/que no pagan.

Con el interruptor Bloquear suscriptores inactivos/que no pagan activado, el BQN bloqueará a los suscriptores basándose en dos posibles criterios:

• Estado de las instancias de servicio y los paquetes (el predeterminado). Si ninguno de ellos está en estado "ACTIVO", el suscriptor será bloqueado.
• Estado de la cuenta del suscriptor. Si se elige esta opción, los suscriptores en estado Suspendido, Hibernado e Inactivo serán bloqueados (códigos de estado 8, 9 y 10, respectivamente).

Los siguientes campos en la facturación de Visp se pueden utilizar como fuente del ID de suscriptor:

• ID de cliente
• Nombre + Apellido
• Nombre de usuario

Las tarifas de política se toman de la instancia de servicio del cliente up_speed y down_speed. También se obtienen las tasas de ráfaga up_burst y down_burst.

Con la información del grupo de suscriptores habilitada, el identificador del punto de acceso asociado al CPE del suscriptor, con un prefijo  “L1-“, será el nombre del grupo de suscriptores, si la información está disponible en la base de datos de Visp.

‍

WISPControl

‍

WISPControl utiliza RADIUS. Consulte el capítulo Interfaz RADIUS.

‍

Wisphub

‍

Wisphub ha desarrollado una integración con BQN utilizando la API REST de BQN. Consulte la documentación del producto Wisphub aquí.

‍

Wispro

‍

El BQN recupera clientes, contratos y planes para aplicar los límites de velocidad.

Para activar Visp, vaya a Configuration->RADIUS/REST/Billing->Billing Systems, seleccione Wispro y active el interruptor.

Se debe proporcionar una clave API válida. La clave API debe generarse en el sistema Wispro. Consulte las instrucciones aquí.

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).  

La siguiente pantalla muestra un ejemplo de configuración de Wispro:

Solo se bloquearán los clientes de Wispro con contratos en estado disabled. Puede cambiar este comportamiento a no bloquear desactivando el interruptor Block Inactive/Not Paying Subscribers.

Los siguientes campos en la facturación de Wispro pueden utilizarse como fuente del ID de suscriptor:

• SubscriberID (“public_id” en el cliente Wispro).
• Nombre.
• Dirección MAC.
• Login (campo “email” en el cliente de Wispro).

Las velocidades de la política se toman del plan del contrato del cliente. Los parámetros del plan ceil_down_kbps y ceil_up_kbps se utilizan como límites de velocidad.

Si un cliente de Wispro tiene más de un contrato, a cada dirección IP se le asignarán los límites de velocidad de su contrato. Si una dirección IP se repite en dos contratos de cliente (esto es una inconsistencia en la base de datos de facturación que no debería ocurrir), se seleccionarán los límites del contacto obtenido el último.

Con la información del grupo de suscriptores habilitada, los nombres de los nodos se utilizarán como grupos de suscriptores, es decir, un suscriptor se asociará a un grupo de suscriptores después del nombre del nodo del contrato, si esa información está disponible en la base de datos de Wispro.

‍

Consideraciones generales sobre la facturación

‍

Servidor DNS

Si el servidor de facturación se especifica por nombre de host en lugar de por su dirección IP, se debe configurar un servidor DNS en el BQN. Vaya a Configuration->Interfaces->Management y complete la sección del servidor DNS. En el siguiente ejemplo, se configura el servidor DNS con la dirección IP 8.8.8.8.

Fuente del ID de suscriptor

‍

El sistema de facturación puede ser la fuente de los ID de suscriptor de BQN. Las opciones de fuentes de ID dependen del sistema de facturación (consulte cada sección de facturación para obtener más detalles).

Para los sistemas de facturación integrados mediante la API REST, el sistema de facturación tiene el control total del ID de suscriptor, que se puede definir explícitamente al crear o editar el suscriptor.

‍

Bloquear suscriptores inactivos / que no pagan

‍

De forma predeterminada, BQN bloqueará a los suscriptores que no pagan. Lo que es un suscriptor que no paga depende del sistema de facturación (consulte cada sección de facturación específica para obtener más detalles). Para evitar que BQN bloquee a los suscriptores que no pagan, desactive el interruptor Bloquear inactivos/que no pagan.

Para los sistemas de facturación integrados mediante REST API, el sistema de facturación tiene el control total de la definición del límite de velocidad y puede bloquear a un suscriptor asignándolo a una política con una velocidad límite de velocidad de 0.

‍

Factor de escala de velocidad

De forma predeterminada, el BQN aplicará los límites de velocidad según lo especificado por el sistema de facturación. Es posible aplicar un factor de escala a esos límites utilizando el campo Escala de límite de velocidad.

Para aplicar un límite de velocidad inferior al de la facturación, utilice un factor inferior al 100%. Por ejemplo, un límite en la facturación de 200 Mbps con un factor del 90% será de 180 Mbps.

Para aplicar una velocidad superior a la de la facturación, utilice un factor superior al 100 % y hasta el 200 % (factor máximo posible). Por ejemplo, una velocidad de 200 Mbps en la facturación con un factor del 150 % será de 300 Mbps.

Para los sistemas de facturación integrados mediante la API REST, el sistema de facturación tiene el control total de la definición del límite de velocidad y puede decidir qué factor, si lo hay, se aplica a los límites enviados al BQN.