cs-serlefin-sapi
home
🛡️ cs-serlefin-sapi
Esta API proporciona servicios de integración para gestión de proveedores y servicios financieros de Serlefin. Incluye endpoints para:
- Consulta y registro de proveedores de servicios financieros
- Autenticación segura de usuarios proveedores
- Gestión de usuarios asociados a proveedores
- Consulta de catálogo de servicios disponibles
- Búsqueda de servicios específicos por código
- Integración con sistemas de cuentas médicas
Todos los servicios se exponen a través de una arquitectura RESTful con comunicación HTTPS y proporcionan acceso seguro a los sistemas backend de Serlefin y cuentas médicas con alta disponibilidad.
🌐 Información Base
- Título de la API: cs-serlefin-sapi
- Versión: 1.0.30
- GroupId: com.colemena-seguros.mulesoft
- Protocolo: REST
- Formato de Datos: JSON
- Seguridad: HTTPS con TLS/SSL
- Puerto: 8081
- Base Path:
/api
🚀 Cómo Comenzar
- Autenticación: Configura el
client_idy credenciales según el ambiente (DEV/QA/PROD) - URL Base: Usa el endpoint base configurado más el path
/api - Encabezados: Agrega los siguientes headers en tus solicitudes:
Content-Type: application/json
Authorization: Bearer {token}
client_id: {client_id}🚀 Cómo Consumir
Puedes acceder y consumir esta API a través de:
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /api/services | Consultar catálogo completo de servicios financieros disponibles |
| POST | /api/providers | Registrar nuevo proveedor de servicios financieros en el sistema |
| GET | /api/providers-users | Obtener listado de usuarios asociados a proveedores |
| POST | /api/authenticate-providers-users | Autenticar usuarios proveedores con credenciales seguras |
| POST | /api/services-by-code | Buscar servicios específicos mediante código identificador |
⚠️ 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 | La solicitud fue exitosa | Operación completada correctamente | Continuar con el procesamiento |
400 | ❌ Bad Request | Parámetros faltantes o inválidos | Formato de datos incorrecto | Revisar estructura del JSON |
401 | 🔒 Unauthorized | Autenticación fallida | Client_id inválido o faltante | Verificar credenciales de autenticación |
404 | 🔍 Not Found | Endpoint o recurso no encontrado | URL incorrecta | Verificar la ruta del endpoint |
405 | 🚫 Method Not Allowed | Método HTTP no permitido | Usar GET en lugar de POST | Verificar el método HTTP correcto |
406 | ⚠️ Not Acceptable | Formato de respuesta no aceptable | Headers Accept incorrectos | Ajustar headers de aceptación |
415 | 📄 Unsupported Media Type | Tipo de contenido no soportado | Content-Type incorrecto | Usar application/json |
500 | 💥 Internal Server Error | Error inesperado en el servidor | Fallo interno del sistema | Contactar soporte técnico |
501 | 🛠️ Not Implemented | Funcionalidad no implementada | Endpoint en desarrollo | Verificar documentación actualizada |
503 | 🔧 Service Unavailable | Servicio temporalmente no disponible | Sistema backend no disponible | Reintentar más tarde |
🔍 Formato de Errores
{
"message": "Bad request",
"errorDetail": {
"description": "Campo requerido faltante",
"detailedDescription": "El campo 'serviceCode' es obligatorio"
}
}📞 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 generada en Noviembre 2025 - API cs-serlefin-sapi v1.0.0
© 2025 Fundación Grupo Social - Colmena. Sistema de integración Serlefin
📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente consulta el Portal de Exchange oficial.
🔒 Aviso de Seguridad: Nunca compartas credenciales de API en repositorios públicos. Usa variables de entorno para información sensible y mantén actualizados los certificados de seguridad.