Api Zlp v2.0 Enterprise
Sistema Operativo
Console Dashboard Health Check OpenAPI Spec (JSON)

🔌 Guía de Conexión y Consumo de la API

Esta API proporciona servicios enterprise de identidad, autenticación multi-factor (MFA), SSO con Google, envío de correos vía SMTP central o dedicado, Vault de secretos y webhooks.

1. Métodos de Autenticación Requeridos

A) Autenticación de Usuarios (JWT Access Tokens)

Usa el token obtenido al iniciar sesión en /api/v1/auth/login o /api/v1/auth/google.

Header: Authorization: Bearer <tu_access_token>
B) Autenticación Server-to-Server M2M (API Keys)

Para aplicaciones de fondo, microservicios y clientes automatizados.

Header: X-API-Key: zlp_pk_<tu_api_key>

2. Servicio de Correo & SMTP (/api/v1/email)

Puedes enviar correos transaccionales usando el servidor SMTP central de la API o la configuración SMTP personalizada de tu Client App.

POST /api/v1/email/send
Payload JSON:
{
  "to": "destinatario@cliente.com",
  "subject": "Notificación Importante",
  "html": "<h1>Hola</h1><p>Mensaje enviado vía API Zlp</p>",
  "clientAppId": "opcional-id-app-cliente"
}

3. Módulos y Endpoints Consumibles de la API

  • Authentication & SSO: /api/v1/auth/login, /api/v1/auth/register, /api/v1/auth/google, /api/v1/auth/refresh
  • MFA (TOTP): /api/v1/auth/mfa/status, /api/v1/auth/mfa/setup, /api/v1/auth/mfa/enable, /api/v1/auth/mfa/verify-recovery
  • Gestión de Usuarios: /api/v1/users (Crear, Listar, Actualizar, Asignar Roles)
  • Autenticación M2M (API Keys): Uso de la cabecera X-API-Key (La administración y generación de tokens se realiza exclusivamente desde la consola web /dashboard)
  • Vault Secrets: /api/v1/vault (Guardar y leer secretos cifrados AES-256)
  • Webhooks: /api/v1/webhooks (Suscribir eventos de seguridad en tiempo real)
  • Health Check: /api/v1/health