Referencia de API
API de Administracion
Endpoints de facturacion, SSO, auditoria, notificaciones y reglas de escalamiento.
Facturacion
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/admin/billing/plan | Plan actual del tenant |
PUT | /api/v1/admin/billing/plan | Cambiar plan |
GET | /api/v1/admin/billing/usage | Uso actual del periodo |
GET | /api/v1/admin/billing/usage/history | Historial de uso mensual |
GET | /api/v1/admin/billing/invoices | Listar facturas |
Ejemplo de respuesta de uso:
{
"agents": { "used": 3, "limit": 5 },
"events": { "used": 4200, "limit": 10000 },
"storage_mb": { "used": 312, "limit": 1024 },
"period_start": "2026-03-01T00:00:00Z",
"period_end": "2026-03-31T23:59:59Z"
}SSO
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/admin/sso/config | Obtener configuracion SSO |
POST | /api/v1/admin/sso/config | Configurar SAML SSO |
PUT | /api/v1/admin/sso/config | Actualizar configuracion |
DELETE | /api/v1/admin/sso/config | Desactivar SSO |
POST | /api/v1/admin/sso/login | Iniciar flujo SSO |
POST | /api/v1/admin/sso/callback | Callback ACS (IdP response) |
Los endpoints de SSO requieren plan Enterprise y permiso
manage_settings.Auditoria
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/admin/audit | Listar registros |
GET | /api/v1/admin/audit/export | Exportar para cumplimiento |
GET | /api/v1/admin/audit/resource/{resource_type}/{resource_id} | Historial de recurso |
GET | /api/v1/admin/audit/verify-chain | Verificar integridad |
Filtros disponibles para el listado:
| Parametro | Tipo | Descripcion |
|---|---|---|
resource_type | string | Tipo de recurso |
resource_id | string | ID del recurso |
action | string | create, update, delete |
actor | string | ID del actor |
start_date | date | Inicio del rango |
end_date | date | Fin del rango |
Notificaciones
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/admin/notifications | Listar notificaciones |
POST | /api/v1/admin/notifications | Crear notificacion |
PUT | /api/v1/admin/notifications/{notification_id}/read | Marcar como leida |
PUT | /api/v1/admin/notifications/read-all | Marcar todas como leidas |
GET | /api/v1/admin/notifications/preferences | Preferencias del usuario |
PUT | /api/v1/admin/notifications/preferences | Actualizar preferencias |
Tipos de notificacion: alert, task, maintenance, system, billing.
Canales disponibles: in_app, email, whatsapp, push.
Reglas de Escalamiento
Las reglas definen como se escalan alertas no atendidas:
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/admin/escalation-rules | Listar reglas |
POST | /api/v1/admin/escalation-rules | Crear regla |
PUT | /api/v1/admin/escalation-rules/{rule_id} | Actualizar regla |
DELETE | /api/v1/admin/escalation-rules/{rule_id} | Eliminar regla |
{
"name": "Escalar alarmas criticas",
"trigger": { "event_type": "alarm", "severity": "critical", "unattended_minutes": 30 },
"actions": [
{ "type": "notify", "target": "user_supervisor_id", "channel": "whatsapp" },
{ "type": "reassign", "target": "user_supervisor_id" }
]
}Las reglas de escalamiento se evaluan cada minuto. Asegurate de que los tiempos de escalamiento sean razonables para evitar notificaciones excesivas.