Documentación de BQN
Cerrar icono

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

Despliegue de REST

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

Se admiten tanto direcciones IPv4 como IPv6. En el caso de las direcciones IPv6, la API REST aplica una máscara de subred (/64 por defecto), ya que se considera que todas las direcciones de la misma subred pertenecen al mismo abonado.

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 de REST y selección de políticas

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

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

El siguiente diagrama muestra un ejemplo en el que se crean varias políticas y posteriormente cada abonado tiene asignada una de esas políticas.

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

La API REST se describe con más detalle en la guía Guía de la API REST de BQNque incluye la definición de todas las peticiones posibles.

Configuración REST

Configurar REST en el BQN

1. Para activar la API REST en el BQN, vaya a Configuración->RADIUS/REST/Facturación->API REST y active la API Rest .

2. Añada las direcciones IP de todos los clientes REST a la configuración de BQN. En la interfaz gráfica de usuario, vaya a Configuración->RADIUS/REST/Facturación->API REST y haga clic en Añadir cliente...

3. Añada los usuarios REST, junto con sus contraseñas, a la configuración de BQN. En la interfaz gráfica de usuario, vaya a Configuración->RADIUS/REST/Facturación->API REST y haga clic en Añadir usuario...

Comprobar los clientes REST

La integración de la API REST requiere programar 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, se pueden enviar mensajes REST manualmente mediante la utilidad 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}}'


Compruebe la API REST

Una vez creadas las políticas y las asociaciones de abonados, la tabla Estado->Políticas->Políticas de tarificación mostrará las políticas procedentes de REST. Por ejemplo, la siguiente tabla muestra tres políticas, con suscriptores provisionados 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 abonados 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 Unix de BQN.

Busque los siguientes directorios:

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

Si los directorios no salen, créalos:


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 certificados al servidor BQN).

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

Etiquetas de estilo Docs
[.p-highlight] Lorem ipsum... [.p-highlight]

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.

[.p-highlight-blue] Lorem ipsum... [.p-highlight-blue]

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.

[.p-highlight-red] Lorem ipsum... [.p-highlight-red]

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.

Vista previa para el estilo de una sola [.c-highlight]palabra monoespaciada[.c-highlight].
Avance del single word mono-spaced con estilo.
anterior
SIGUIENTE