cs-visual-time-sapi-v2
home
🛡️ cs-visual-time-sapi-v2
Solución integral de gestión de seguros y emisión de pólizas que permite interactuar directamente con el sistema Visual Time y base de datos. Incluye endpoints para:
- Emisión de pólizas de vida individual y colectiva
- Procesamiento de seguros generales y matriz de productos
- Gestión completa de asegurados y beneficiarios
- Procesamiento de endosos y ajustes retroactivos
- Emisión y liberación de reservas y objeciones
- Consulta de información de pólizas y certificados
- Generación de condiciones de texto y carátulas
- Gestión de cuotas, acumulación y scoring
Todos los servicios exponen operaciones REST con soporte JSON y proporcionan integración robusta con Visual Time API para transacciones seguras de alto volumen en el sector asegurador.
🌐 Información Base
- Título de la API: cs-visual-time-sapi-v2
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- URL Base Producción:
https://cs-visual-time-sapi-prod-v2.us-e1.cloudhub.io/api/ - URL Base QA:
https://cs-visual-time-sapi-qa-v2.us-e1.cloudhub.io/api/ - Protocolo: REST (HTTPS)
- Formato de Datos: JSON
- Autenticación: OAuth 2.0 + Client ID Enforcement
🚀 Cómo Comenzar
- Autenticación: Asegúrate de tener el
client_idyclient_secretrequeridos junto con el token BearerOAuth 2.0para acceso seguro. - URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
- 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" # Requerido para trazabilidad🚀 Cómo Consumir
Puedes acceder y consumir esta API a través de las siguientes plataformas:
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/send-payments-orders | Obtener órdenes de pago para procesamiento |
| POST | /api/receive-payments-orders | Recibir resultado final de órdenes procesadas por billeteras virtuales |
| POST | /api/quoting/issuing-of-policy | Obtener cotización de seguro para emisión de póliza |
| GET | /api/quoting/release-or-issuance-of-Policy | Liberación o emisión de póliza |
| POST | /api/creation-of-insured-persons | Inclusión de personas aseguradas en pólizas institucionales |
| PUT | /api/update-of-insured-amounts | Actualizar montos asegurados |
| PUT | /api/client-newness | Actualizar datos de asegurados, dependientes y beneficiarios |
| GET | /api/obtain-information/modulebysalechannel | Consultar información en BD tabla vt_core_modulebysalechannel |
| PUT | /api/update-modulebysalechannel | Actualizar estado de frecuencias de pago en tabla vt_core_modulebysalechannel |
| POST | /api/addRemoveDependentInsureds | Agregar/remover asegurados dependientes |
| PUT | /api/updatePolicyBeneficiaries | Actualizar beneficiarios de póliza |
| GET | /api/obtainPolicyAndCertificates/{insurArea}/{branch}/{product}/{policy}/{certificate} | Consulta de información de pólizas de seguros generales y vida |
| GET | /api/obtainPolicyAndCertificatByCode/{insurArea}/{codeHash} | Consultar producto de cumplimiento mediante código de verificación |
| GET | /api/quotaAccumulationScore | Servicio de consulta de cuota, acumulación y score |
| POST | /api/retriveIssueCompliancePolicy | Recuperar emisión de póliza de cumplimiento |
| POST | /api/retriveEndorsementCompliance | Recuperar cumplimiento de endoso |
| PUT | /api/reserve-adjustment | Ajuste de reserva |
| POST | /api/textConditions | Condiciones de texto para carátulas |
| POST | /api/claim-beneficiary | Reclamación de beneficiario |
| PUT | /api/retroactive-endorsement-adjustment | Ajuste de endoso retroactivo |
| PUT | /api/release-reserve-objection | Liberación de objeción de reserva |
| POST | /api/standardIssue/retriveStandardLifeIssue | Servicio emisión estándar de vida |
| POST | /api/standardIssue/retrivePolicyLifeIssueMatriz | Servicio emisión estándar colectivo vida (matriz) |
| POST | /api/standardIssue/retriveStandardGeneralMatrizIssue | Servicio emisión matriz productos generales |
⚠️ Manejo de Errores
Se utilizan códigos de estado HTTP estándar para el manejo de errores:
📊 Códigos de Respuesta
| Código | Estado | Descripción | Causa Común | Acción Recomendada |
|---|---|---|---|---|
200 | ✅ OK | Operación procesada exitosamente | Emisión/consulta aprobada por Visual Time | Continuar con el flujo de negocio |
400 | ❌ Bad Request | Parámetros faltantes o inválidos | Datos de póliza incorrectos, montos negativos | Revisar estructura del JSON y validar campos requeridos |
401 | 🔒 Unauthorized | Autenticación fallida | Token expirado o client_id inválido | Renovar token de autenticación OAuth |
403 | 🚫 Forbidden | Sin permisos suficientes | Client_id sin permisos para emisión de pólizas | Verificar permisos y configuración del usuario |
404 | 🔍 Not Found | Recurso no encontrado | Póliza inexistente, certificado no encontrado | Verificar números de póliza y referencias |
422 | ⚠️ Unprocessable Entity | Operación rechazada por Visual Time | Datos inconsistentes, reglas de negocio violadas | Verificar datos y cumplir reglas de emisión |
429 | ⏰ Rate Limited | Demasiadas solicitudes | Exceso de requests por minuto | Implementar retry con exponential backoff |
500 | 💥 Internal Server Error | Error inesperado en el servidor | Fallo interno del sistema Visual Time | Contactar soporte técnico con correlation ID |
503 | 🛠️ Service Unavailable | Servicio temporalmente no disponible | Mantenimiento Visual Time, BD caída | Reintentar más tarde, notificar al usuario |
504 | ⏱️ Gateway Timeout | Timeout en Visual Time API | Respuesta lenta del sistema core | Consultar estado de operación antes de reintentar |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Septiembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación generada y actualizada en Diciembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-visual-time-sapi-v2
📋 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. Cumple con normativas de protección de datos personales al manejar información de asegurados.
🏥 Aviso Legal: Las emisiones de pólizas están sujetas a términos y condiciones de la aseguradora. Las operaciones pueden estar sujetas a validaciones regulatorias según el tipo de seguro y jurisdicción. Todas las transacciones quedan registradas para auditoría y cumplimiento normativo.