Saltar al contenido
Guía GPON

API de Oltixa: conecta tu WISPA (u otro sistema) por X-Token

API de Oltixa para tu sistema de cobros: crea, corta, reconecta, cambia de plan y da de baja clientes de fibra o inalámbricos; Oltixa toca la ONU, el PPPoE y la IP. Tokens con permiso. Compatible con SmartOLT.

Tu sistema de cobros manda por cliente; Oltixa decide qué equipo tocar. Tu WISPA (u otro sistema) le dice a Oltixa “crea este servicio”, “córtalo”, “reconéctalo”, “cámbiale el plan” o “dale de baja”, usando el número de servicio de tu sistema (ext:<id>). Oltixa sabe qué ONU, qué usuario PPPoE y qué IP tiene ese cliente, y lo hace todo junto, con historial y motivo.

1 · Token y permisos

Toda petición lleva X-Token. En tu panel (Ajustes → API) creas tokens con permiso: Solo lectura (no puede escribir), Clientes (el de tu WISPA) o Total. Se muestran una sola vez.

2 · Lo esencial

POST /api/customer/sync/ext%3A9001          crear o actualizar y aplicar (PPPoE, IP fija, plan)
POST /api/customer/suspend/ext%3A9001       cortar (motivo obligatorio; no borra nada)
POST /api/customer/reactivate/ext%3A9001    reconectar
POST /api/customer/change_plan/ext%3A9001   cambio de plan en MikroTik y ONU
POST /api/customer/terminate/ext%3A9001     baja: borra PPPoE, libera IP, apaga la ONU
POST /api/customer/bulk_suspend             hasta 50 clientes por llamada
POST /api/customer/schedule/ext%3A9001      programar un corte o reconexión para una fecha y hora
POST /api/customer/schedule_cancel/ext%3A9001  cancelar la orden programada
POST /api/customer/bulk_schedule            hasta 200 órdenes programadas por llamada
GET  /api/customer/schedules                consultar y conciliar (estado, fecha, ext)
POST /api/onu/authorize_onu                 instalar una ONU unida al cliente (customer_id=ext:...)

Cortes programados: tu sistema de cobros decide a quién y cuándo; Oltixa guarda la orden y, a la hora, le pregunta a tu sistema si el corte sigue vigente. Solo corta si él lo confirma.

Por falta de pago se corta solo en el MikroTik: así el cliente ve tu página de aviso de deuda (la redirección la crea Oltixa con vista previa, antes del fasttrack). HTTPS no se puede redirigir: ahí solo se bloquea.

3 · Respuestas

{ "status": true, ... }
{ "status": false, "error": "...", "error_code": "not_found", "retryable": false }

Repetir una orden es seguro: la respuesta dice "already": true si ya estaba así. Con el header Idempotency-Key (o la firma HMAC v1) un reintento devuelve la misma respuesta sin ejecutar dos veces.

4 · ¿Vienes de SmartOLT?

Las rutas estilo SmartOLT (/api/onu/disable, enable, get_*…) siguen funcionando igual: cambia solo la URL base. Solo apagan o prenden la ONU; para cortar clientes usa customer/suspend. No mezcles las dos.

El manual técnico completo (campos, errores, ejemplos curl) se entrega a cada empresa desde su panel y en la documentación del proyecto (docs/API.md).

Hazlo con un clic en Oltixa

Tu OLT en un panel: autoriza, cambia planes, corta y mira la señal sin consola. Gratis hasta 1000 ONU.

Crear cuenta gratis