cs-insurance-pc-xapi

🛡️ cs-insurance-pc-xapi

Experience layer para seguros generales de Fundación Grupo Social - Colmena. Esta API proporciona:

• Emisión de pólizas compuestas: Recuperar cumplimiento de emisión de pólizas
• Gestión de contacto de trabajadores: Habeas Data - Términos y condiciones

Todos los servicios se exponen a través de una arquitectura REST optimizada.

🌐 Información Base

• Título de la API: cs-insurance-pc-xapi
• Versión: 1
• Plataforma: MuleSoft Anypoint Platform
• Protocolo: HTTPS
• Formato de Datos: JSON
• Autenticación: OAuth 2.0 + Client ID Enforcement

Configuración de Ambientes

🚀 Cómo Comenzar

1. Autenticación: Asegúrate de tener el client_id y client_secret requeridos para el token Bearer OAuth 2.0.
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 "client_secret: TU_CLIENT_SECRET"
-H "Authorization: Bearer TU_ACCESS_TOKEN"
-H "X-Correlation-ID: TU_CORRELATION_ID"  # Recomendado para trazabilidad

🚀 Cómo Consumir

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

• 🔗 MuleSoft Exchange
• 🔗 Portal Público FGS

📍 Endpoints Disponibles

⚠️ Manejo de Errores

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

📊 Códigos de Respuesta

Preguntas Frecuentes y Solución de Problemas

Error 401 - Unauthorized

• Síntomas: Respuesta "Authentication failed" o "Invalid token"
• Causas: Token expirado (>24 horas), client_id o client_secret incorrectos, headers malformados
• Solución:
  • Renovar token OAuth 2.0 con servicio de autenticación
  • Verificar formato de headers: Authorization: Bearer {token}
  • Validar que client_id y client_secret sean correctos

Error 504 - Gateway Timeout

• Síntomas: Timeout después de 30-60 segundos
• Causas: Servicios backend lentos, consultas complejas, sobrecarga del sistema
• Solución:
  • Configurar timeout del cliente a 60 segundos mínimo
  • Implementar retry con exponential backoff (3 intentos)
  • Contactar soporte si persiste con correlation ID

Error 429 - Rate Limiting

• Síntomas: "Too Many Requests" o "Rate limit exceeded"
• Causas: Exceso de requests por minuto (límite: 100 req/min por client_id)
• Solución:
  • Implementar queue con rate limiting en cliente
  • Espaciar requests con delays de 600ms mínimo
  • Considerar procesamiento por lotes (batch)

Error 400 - Bad Request con Validación de Campos

• Síntomas: "Invalid field format" o "Required field missing"
• Causas: Campos faltantes, tipos de datos incorrectos, valores fuera de rango
• Solución:
  • Revisar estructura JSON contra ejemplos de documentación
  • Validar tipos de datos (string, number, date)
  • Verificar campos obligatorios según endpoint

Error 404 - Not Found al Consultar Póliza

• Síntomas: "Policy not found" o "Certificate not found"
• Causas: policyId/certificateNumber inexistente, área/rama/producto incorrectos
• Solución:
  • Verificar que la póliza/certificado exista en el sistema
  • Validar parámetros de URL (insurArea, branch, product)
  • Comprobar que la póliza esté en estado activo

📞 Soporte

Para asistencia técnica, consultas sobre la API o reportar incidencias, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

Última actualización: Noviembre 2025

Versión de documentación: 1.0.0

Documentación generada para la API cs-insurance-pc-xapi

© 2025 Fundación Grupo Social - Colmena.

📋 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 MuleSoft Exchange oficial.

🔒 Aviso de Seguridad: Nunca compartas credenciales de API (client_id, client_secret, tokens) en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente cada 30 días.

⚠️ Disclaimer: Los ejemplos de esta documentación utilizan datos ficticios. Para pruebas, utiliza el ambiente de QA con datos de prueba proporcionados por el equipo de integración.