cs-notifications-papi icon

cs-notifications-papi

0.0.x
(0 reviews)
API para gestionar y enviar notificaciones por correo electrónico y SMS, integrando servicios externos y permitiendo el seguimiento de envíos y respuestas de manera eficiente y segura.

🛡️ cs-notifications-papi

Esta API proporciona servicios integrales de notificaciones multicanal para la gestión y envío de comunicaciones empresariales. Incluye endpoints para:

  • Envío de correos electrónicos mediante AWS SES SMTP con soporte HTML
  • Envío de SMS mediante Twilio y Masivapp con gestión de mensajes largos
  • Seguimiento y tracking de notificaciones de email enviadas
  • Gestión de plantillas con reemplazo dinámico de datos
  • Configuración de URLs acortadas para SMS
  • Soporte para múltiples destinatarios (to, cc) y archivos adjuntos
  • Mensajes flash y personalización de datos

Todos los servicios se exponen a través de versiones organizadas (v1, v2) y proporcionan acceso seguro a servicios de notificación con alta disponibilidad y performance optimizado.

🌐 Información Base

  • Título de la API: cs-notifications-papi
  • Versión: 1.0.0
  • Plataforma: Anypoint Platform
  • URL Base Producción: https://cs-notifications-papi-prod.us-e1.cloudhub.io/api/
  • URL Base QA: https://cs-notifications-papi-qa.us-e1.cloudhub.io/api/
  • URL Base Dev: https://cs-notifications-papi-dev.us-e1.cloudhub.io/api/
  • Protocolo: REST
  • Formato de Datos: JSON / Multipart Form-Data
  • Autenticación: OAuth 2.0 + Client ID

🚀 Cómo Comenzar

  1. Autenticación: Asegúrate de tener el client_id requerido y el token Bearer OAuth 2.0 para acceso seguro.
  2. URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
  3. Encabezados: Agrega los siguientes encabezados en tus solicitudes de API:
-H "Content-Type: application/json"
-H "client_id: TU_CLIENT_ID"
-H "Authorization: Bearer TU_ACCESS_TOKEN"
-H "X-Transaction-ID: TU_TRANSACTION_ID"  # Opcional pero recomendado para trazabilidad

🚀 Cómo Consumir

Puedes acceder y consumir esta API a través de las siguientes plataformas:

📍 Endpoints Disponibles

MétodoEndpointDescripción
POST/api/emailEnviar correo electrónico mediante AWS SES SMTP con soporte HTML y adjuntos
POST/api/smsEnviar SMS mediante Masivapp con soporte para mensajes largos y URLs cortas
POST/api/twilio/smsEnviar SMS mediante Twilio con reemplazo dinámico de variables
GET/api/email/notification-trackConsultar estado y tracking de notificaciones de email enviadas (v1)
GET/api/v2/email/notification-trackConsultar estado y tracking de notificaciones de email enviadas (v2 mejorado)

⚠️ Manejo de Errores

Se utilizan códigos de estado HTTP estándar para el manejo de errores:

📊 Códigos de Respuesta

CódigoEstadoDescripciónCausa ComúnAcción Recomendada
200✅ OKLa solicitud fue exitosaNotificación enviada correctamenteContinuar con el procesamiento
400❌ Bad RequestParámetros faltantes o inválidosFormato de email/teléfono incorrectoRevisar estructura del JSON y campos requeridos
401🔒 UnauthorizedAutenticación fallidaToken expirado o client_id inválidoRenovar token de autenticación
403🚫 ForbiddenSin permisos suficientesClient_id sin permisos para el endpointVerificar permisos asignados al client_id
404🔍 Not FoundEndpoint o recurso no encontradoURL incorrecta o tracking ID inexistenteVerificar la URL y documentación
405🚷 Method Not AllowedMétodo HTTP no permitidoUsar POST en lugar de GET o viceversaVerificar el método HTTP correcto
406🚧 Not AcceptableFormato de respuesta no soportadoHeader Accept con formato no soportadoUsar application/json
415📎 Unsupported Media TypeTipo de contenido no soportadoContent-Type incorrectoUsar application/json o multipart/form-data
429⏰ Rate LimitedDemasiadas solicitudesExceso de requests por minutoImplementar retry con exponential backoff
500💥 Internal Server ErrorError inesperado en el servidorFallo interno del sistemaContactar soporte técnico con transaction ID
501🛠️ Not ImplementedFuncionalidad no implementadaEndpoint en desarrolloVerificar versión de la API
503🔧 Service UnavailableServicio temporalmente no disponibleAWS SES/Twilio/Masivapp no disponiblesReintentar más tarde

Estructura de Error Estándar

{
  "code": 400,
  "message": "Bad request - Invalid email format",
  "transactionId": "550e8400-e29b-41d4-a716-446655440000"
}

📞 Soporte

Para asistencia técnica, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

Equipo de Soporte: Fundación Grupo Social - Colmena

📅 Información Adicional

Documentación creada y actualizada en Noviembre 2025 por GitHub Copilot

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-notifications-papi

📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.

🔒 Aviso de Seguridad: Nunca compartas credenciales de API en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente. Cumple con GDPR y normativas locales de protección de datos al enviar comunicaciones.

📧 Privacidad: Al usar esta API, asegúrate de tener el consentimiento explícito de los destinatarios para enviar notificaciones. Implementa mecanismos de opt-out y respeta las preferencias de comunicación de los usuarios.

Reviews