Documentación de BQN

La referencia de la API REST se puede encontrar en Guía de la API REST de BQN.

‍

Implementación de REST

‍

Las políticas de velocidad de los suscriptores del BQN y la asignación de suscriptores a las políticas de velocidad de los suscriptores se pueden realizar a través de una API REST, que también puede proporcionar métricas de los suscriptores. Para ello, por supuesto, el BQN debe ver las direcciones IP del tráfico de datos de los suscriptores, es decir, no puede haber un NAT entre los suscriptores y el BQN, porque los límites del plan se aplicarán para cada dirección IP. También es importante que los wires estén conectados correctamente (es decir, que los puertos de red configurados como puertos de acceso estén conectados en el lado de los suscriptores).

Se admiten direcciones IPv4 e IPv6. En el caso de las direcciones IPv6, la API REST aplica una máscara de subred (/64 por defecto), ya que todas las direcciones de la misma subred se consideran pertenecientes al mismo suscriptor.

La integración se realiza entre un sistema que controla la definición del plan (por ejemplo, un sistema de facturación) y el BQN, a través de la interfaz de gestión del BQN. El BQN actúa como servidor de la API REST. El BQN utiliza la dirección IP de gestión (la misma que utiliza la GUI) para recibir los mensajes REST, escuchando en el puerto TCP 3443 (configurable).

‍

Definición REST y Selección de Políticas

‍

A través de la API REST, las siguientes operaciones de política son posibles:

• Crear políticas de planes (los planes de suscripción).
• Asignar un plan a un suscriptor.
• Obtenga métricas de suscriptor de hasta 3 meses: volumen utilizado, velocidad máxima, latencia, retransmisiones, flujos activos/creados, tráfico con congestión y a velocidad máxima, información DPI, etc.
• Gestione las cuotas de tiempo y volumen.

El siguiente diagrama muestra un ejemplo en el que se crean varias políticas y luego a cada suscriptor se le asigna una de esas políticas.

Existen operaciones para crear, listar, modificar y eliminar tanto las políticas como las asociaciones de suscriptores.

La API REST se describe con más detalle en la Guía de la API REST de BQN, que incluye la definición de todas las solicitudes posibles.

‍

Configuración REST

‍

Configurar REST en el BQN

‍

1.      Para activar la API REST en el BQN, vaya a Configuration->RADIUS/REST/Billing->REST API y cambie Rest API a On.

2.      Agregue las direcciones IP de todos los clientes REST a la configuración del BQN. En la GUI, vaya a Configuration->RADIUS/REST/Billing->REST API y haga clic en Add Client…

3.      Agregue los usuarios REST, junto con sus contraseñas, a la configuración del BQN. En la GUI, vaya a Configuration->RADIUS/REST/Billing->REST API y haga clic en Add User…

‍

‍

Comprobar clientes REST

La integración de la API REST requiere la programación de la API en el elemento que interactúa con el BQN, por ejemplo, un sistema de facturación. Para comprobar que la configuración REST de BQN es correcta, los mensajes REST se pueden enviar manualmente utilizando la utilidad de Linux curl.

Como ejemplo, para crear una política llamada my_rest_policy_1 y asignarla a un suscriptor con 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}}'

Comprobar la API REST

‍

Una vez que se crean las políticas y las asociaciones de suscriptores, la tabla Estado->Políticas->Políticas de velocidad mostrará las políticas procedentes de REST. Por ejemplo, la siguiente tabla muestra tres políticas, con suscriptores aprovisionados que también están activos (con tráfico):

Para ver la lista de suscriptores con políticas REST, seleccione Estado->Suscriptores->Atributos del suscriptor. El siguiente ejemplo muestra diez suscriptores y sus políticas asociadas:

‍

Si se necesita un certificado digital en el BQN

‍

A veces, los clientes REST necesitan un certificado digital específico para validar el acceso.

Inicie sesión como root en el shell de Unix de BQN.

Busque los siguientes directorios:

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

‍

Si los directorios no existen, créelos:

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 el certificado y su clave en los siguientes archivos:

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

(puede utilizar scp para transferir previamente los archivos de certificado al servidor BQN).

‍

Para aplicar el cambio, reinicie el servidor BQN en Administration->Reboot.