Bitácora de Envíos API
1. Descripción General
La Bitácora de Envíos API es un módulo diseñado para ofrecer un registro completo, estructurado y auditable de todas las solicitudes realizadas hacia la plataforma por medio de integraciones API. Su objetivo principal es permitir al cliente confirmar que los procesos de envío ejecutados desde su infraestructura han sido recibidos, procesados y atendidos correctamente por la plataforma.
Es importante destacar que este módulo no está destinado a validar la entrega del SMS al destino final. Su alcance se enfoca exclusivamente en proporcionar una vista técnica del flujo de solicitudes API, facilitando la verificación de que cada proceso enviado desde los sistemas del cliente haya sido gestionado de manera adecuada dentro de la plataforma.
2. Alcance del Módulo
La Bitácora API permite:
- Confirmar la recepción de solicitudes API por parte de la plataforma.
- Validar que la estructura, datos y parámetros enviados sean correctos.
- Identificar errores generados durante el procesamiento interno de la solicitud.
- Auditar solicitudes históricas recientes, aun cuando haya transcurrido un lapso prolongado sin actividad.
Nota: Este módulo no valida estados de entrega a operadores, ni muestra información relacionada con la entrega final del mensaje al número destino.
3. Objetivos
Los principales objetivos del módulo son los siguientes:
-
Visualización en tiempo real de registros API:
Permite conocer inmediatamente si la plataforma recibió cada una de las solicitudes enviadas. -
Sistema de filtros avanzados con validación de entrada:
Incluye filtros por fechas, identificadores, tipo de cuenta, estatus de la solicitud y tipo de error, garantizando búsquedas seguras y precisas. -
Exportación de registros en formato CSV:
Facilita el análisis externo, auditorías y la elaboración de reportes. -
Compatibilidad con distintos tipos de cuenta:
Aplicable a cuentas Reseller, Regulares y Subcuentas, respetando las jerarquías y permisos correspondientes. -
Acceso a los registros de los últimos envíos:
Independientemente del tiempo transcurrido desde la última operación, la bitácora conserva los registros más recientes para consulta y auditoría.
4. Funcionalidad General
El sistema registra y presenta información clave de cada solicitud API, tales como:
- Fecha y hora de recepción.
- Datos del remitente y tipo de cuenta.
- Parámetros enviados por el cliente.
- Código y descripción del resultado del proceso.
- Tipo de error, en caso de existir.
- Respuesta generada por la plataforma.
Estos elementos aseguran una trazabilidad completa del proceso técnico desde el sistema del cliente hasta la plataforma.
5. Tipos de Error Soportados
La Bitácora API clasifica los errores generados durante el procesamiento en las siguientes categorías, permitiendo un diagnóstico preciso:
Validación
Errores generados por estructura incorrecta o datos inválidos. Incluye:
- Formato inconsistente
- Parámetros faltantes
- JSON mal formado
Errores derivados de restricciones de bolsón. Ejemplos:
- Fondos insuficientes
- Límites de consumo superados
Autorización
Ocurren cuando el usuario o la cuenta no poseen los permisos necesarios para ejecutar la acción requerida.
Regla de Negocio
Violaciones a políticas internas o configuraciones específicas definidas para la cuenta.
No Encontrado
Se produce cuando la solicitud hace referencia a recursos inexistentes, tales como:
- Alfanuméricos no configurados
- Identificadores no válidos
Error del Servidor
Errores internos inesperados que impiden completar el procesamiento.
Autenticación
Relacionados con credenciales inválidas, expiradas o incorrectas.
Desconocido
Errores no clasificados o incidentes excepcionales.
6. Beneficios para el Cliente
- Permite evaluar el funcionamiento de la integración sin depender de la entrega final del SMS.
- Facilita la identificación de incidentes originados desde el desarrollo del cliente.
- Mejora la trazabilidad y auditoría de las operaciones API.
- Reduce tiempos de diagnóstico y resolución de problemas de integración.
- Brinda transparencia del comportamiento técnico de la plataforma.
