MANUAL DEL ADMINISTRADOR

API REST v1

Activa la API en Gestión de personal, pide un token Bearer y prueba clientes, facturas, pagos, tickets y aprovisionamiento OLT.

Documentación de la API oficial para operadores y terceros. Sirve para conectar apps, pasarelas o scripts con el mismo alcance que el panel: clientes, facturas, pagos, red, OLT, reportes y tickets.

Antes de cualquier petición, el operador debe tener la API habilitada en Ajustes → Gestión de personal.

Laboratorio API REST v1
POST /auth/token

Obtener token

Esta ruta no tiene parámetros.
Response Sin enviar
Pulsa Conectar para pedir un token o Enviar para probar la ruta seleccionada.

Las peticiones salen desde tu navegador hacia el dominio que indiques. El token se guarda solo en esta pestaña.
SECCIONES

¿Qué necesitas hacer?

Selecciona una sección para abrir sus instrucciones y pasos detallados.

01

1. Activar el acceso API

Sin este paso el login de la API responde api_disabled (HTTP 403), aunque el usuario y la contraseña sean correctos. Entra al panel administrativo de tu in...

0 subsecciones Abrir sección →
02

2. URL base y autenticación

Todas las respuestas son JSON, salvo GET /invoices/{id}/pdf.

5 subsecciones Abrir sección →
03

3. Permisos

Cada ruta exige la misma clave que el panel (login.acceso). Si el operador no puede crear facturas en el panel, tampoco podrá crearlas por API. Recurso Per...

0 subsecciones Abrir sección →
04

4. Formato de respuesta

{ "ok": true, "data": {}, "meta": { "page": 1, "per_page": 25, "total": 10, "last_page&quo...

3 subsecciones Abrir sección →
05

5. Clientes

Activar, suspender o retirar actualiza el estado en la base de datos y aplica el corte o la reactivación en routers/RADIUS, con el mismo motor que el panel...

8 subsecciones Abrir sección →
06

6. Facturas

Filtros: customer_id, status. Permiso: finanzas.facturas.menu.

6 subsecciones Abrir sección →
07

7. Pagos

POST /payments registra el pago con el mismo procesador del panel: marca la factura y reactiva el servicio si corresponde.

5 subsecciones Abrir sección →
08

8. Routers y monitores

Las credenciales de router o emisor no se exponen.

5 subsecciones Abrir sección →
09

9. OLT (aprovisionamiento)

Los listados leen el espejo en base de datos (el mismo que el panel). No abren CLI ni SNMP. Las credenciales de la OLT no se exponen. Permiso de lectura: g...

10 subsecciones Abrir sección →
10

10. Reportes de pago

Filtros: customer_id, pending=1. Permiso: finanzas.reporte.menu.

3 subsecciones Abrir sección →
11

11. Tickets

Filtros: customer_id, status. Permiso: soporte.listar.

7 subsecciones Abrir sección →
12

12. Servicios

No se devuelven contraseñas PPP ni claves Wi-Fi. Permiso: clientes.usuarios.menu.

4 subsecciones Abrir sección →
13

13. Facturación

Mora, reconexión, zona, día de pago y corte del cliente. Permiso: clientes.facturacion.configuracion-factura. { "customer_id": 12, "late_fee...

2 subsecciones Abrir sección →
14

14. Catálogos

Permiso: clientes.usuarios.menu.

2 subsecciones Abrir sección →
15

15. Seguridad

El token es de un operador concreto: hereda su acceso. No hay super-token anónimo. No se devuelven contraseñas de portal, token_api, ni usuarios o claves d...

0 subsecciones Abrir sección →