cs-notifications-papi icon

cs-notifications-papi

(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.

home

🛡️ cs-notifications-papi

La API cs-notifications-papi proporciona servicios de notificaciones multicanal para el envío de correos electrónicos y SMS empresariales, incluyendo funcionalidades de seguimiento y gestión de comunicaciones masivas.

Expone operaciones REST para:

  • Envío de correos electrónicos mediante AWS SES con soporte HTML y archivos adjuntos
  • Envío de SMS mediante Masivapp y Twilio
  • Seguimiento y tracking de notificaciones de email enviadas
  • Gestión de correos electrónicos masivos con plantillas
  • Soporte para múltiples destinatarios y archivos en formato Base64

La API actúa como una Process API (PAPI), gestionada desde MuleSoft Anypoint Platform.


🌐 Información Básica

  • Nombre de la API: cs-notifications-papi
  • Versión: 1.0.0
  • Plataforma: MuleSoft Anypoint Platform
  • Tipo: Process API
  • URL Base QA:https://cs-notifications-papi-qa-v1.us-e1.cloudhub.io/api/
  • URL Base Producción:https://cs-notifications-papi-prod-v1.us-e1.cloudhub.io/api/
  • Protocolo: HTTPS / REST
  • Formato de Datos: JSON / Multipart Form-Data

🔐 Autenticación

Para consumir esta API, el consumidor debe enviar obligatoriamente en cada solicitud los siguientes mecanismos de seguridad:

  1. Client ID Enforcement

    • Headers requeridos:
      • client_id
      • client_secret
    • Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
  2. Bearer Token (OAuth 2.0)

    • Header requerido:
      • Authorization: Bearer <access_token>
    • El token debe ser obtenido desde el servicio corporativo de autenticación.
    • El token debe estar vigente al momento de la solicitud.

Ambos mecanismos son requeridos para que la solicitud sea aceptada por la plataforma.

🔒 Aviso de Seguridad
Las credenciales (client_id, client_secret) y los tokens OAuth son información sensible y no deben compartirse ni almacenarse en repositorios públicos.


🚀 Cómo Consumir

La API se encuentra publicada en las siguientes plataformas:

📋 Para consultar detalles de cada método:
1. Navegar en el menú izquierdo de la documentación
2. Expandir la sección "Summary"
3. Seleccionar el método específico que requiere consultar


📍 Endpoints Disponibles

MétodoEndpointDescripción
POST/emailEnviar correo electrónico con archivos adjuntos y contenido HTML
POST/smsEnviar SMS con variables de reemplazo dinámico
POST/twilio/smsEnviar SMS vía Twilio con variables de reemplazo
GET/email/notification-trackConsultar tracking de notificaciones de email (v1)
GET/v2/email/notification-trackConsultar tracking de notificaciones de correo electrónico (v2)
POST/bulk-email-processEnviar correos masivos mediante plantillas predefinidas

⚠️ Manejo de Errores

La API utiliza códigos HTTP estándar para indicar el resultado del procesamiento de las solicitudes.

Estos códigos representan condiciones de autenticación, autorización, formato o disponibilidad del servicio, y no validaciones funcionales propias del negocio.

CódigoEstadoDescripción
200OKSolicitud procesada correctamente
400Bad RequestSolicitud inválida o mal formada
401UnauthorizedCredenciales inválidas o ausentes
403ForbiddenClient ID sin permisos
404Not FoundRecurso no encontrado
405Method Not AllowedMétodo HTTP no permitido
415Unsupported Media TypeTipo de contenido no soportado
429Too Many RequestsLímite de solicitudes excedido
500Internal Server ErrorError interno inesperado
503Service UnavailableServicio temporalmente no disponible

📞 Soporte

Para soporte técnico o incidencias relacionadas con la integración:

Coordinación de Servicios de Integración y Aplicaciones

Correo electrónico: epalma@fgs.co


📅 Información Adicional

Documentación creada en Enero 2026 – Fundación Grupo Social – Colmena

© 2026 Fundación Grupo Social – Colmena


Esta documentación se mantiene actualizada conforme se incorporan nuevos servicios o endpoints relacionados con notificaciones empresariales.


Reviews