cs-visual-time-papi
home
🛡️ cs-visual-time-papi
Esta API proporciona servicios de integración con el sistema de procesos Visual Time, permitiendo la confirmación de pagos de pólizas provenientes del Portal de Pagos.
Los servicios se exponen mediante endpoints REST, actuando como una capa de abstracción y seguridad sobre el sistema Visual Time, gestionada desde MuleSoft.
🌐 Información Base
- Título de la API: cs-visual-time-papi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- URL Base Producción:
https://cs-visual-time-papi-prod-v1.us-e1.cloudhub.io/api/ - URL Base QA:
https://cs-visual-time-papi-qa-v1.us-e1.cloudhub.io/api/ - Protocolo: HTTPS / REST
- Formato de Datos: JSON
🔐 Autenticación y Seguridad
Para consumir esta API, el consumidor debe enviar obligatoriamente en cada solicitud los siguientes mecanismos de seguridad:
Client ID Enforcement
Headers requeridos:
client_idclient_secret
- Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
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 y disponible para consumo a través de:
- 🔗 MuleSoft Exchange – cs-visual-time-papihttps://anypoint.mulesoft.com/exchange/
- 🔗 Portal Público FGShttps://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
📌 El acceso está restringido a consumidores previamente autorizados en Anypoint Platform.
📋 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étodo | Endpoint | Descripción |
|---|---|---|
| POST | /portal-pagos/policy/payment/confirmation | Confirmación de pago de una póliza proveniente del Portal de Pagos |
| POST | /v1/receipts/full-payment | Permite realizar el pago completo de un recibo de póliza en Visual Time, actualizando simultáneamente la vía o método de pago y el estado del recibo. |
⚠️ Manejo de Errores
La API utiliza códigos de estado HTTP estándar para indicar el resultado del procesamiento de cada solicitud.
📊 Códigos de Respuesta
| Código | Estado | Descripción |
|---|---|---|
200 | OK | La solicitud fue procesada correctamente |
400 | Bad Request | La solicitud no cumple con el formato esperado |
401 | Unauthorized | Token OAuth inválido o ausente |
403 | Forbidden | El consumidor no tiene permisos para el recurso |
404 | Not Found | El recurso solicitado no existe |
405 | Method Not Allowed | El método HTTP no está habilitado |
415 | Unsupported Media Type | El Content-Type enviado no es soportado |
429 | Too Many Requests | Se ha superado el límite de solicitudes permitido |
500 | Internal Server Error | Error interno inesperado |
503 | Service Unavailable | Servicio no disponible temporalmente |
📞 Soporte
Para asistencia técnica o incidencias relacionadas con la integración:
Coordinación de Servicios de Integración y Aplicaciones
📧 Correo: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada: Enero 2026
- Para cambios o nuevas versiones, consulta el Portal de Exchange de APIs:https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
🔒 Aviso de Seguridad
Las credenciales (client_id,client_secrety tokens OAuth) son información sensible y deben gestionarse mediante mecanismos seguros.