cs-utilities-system-api-services
home
🛡️ cs-utilities-system-api-services
La API cs-utilities-system-api-services provee una colección de servicios utilitarios corporativos que soportan operaciones transversales para múltiples sistemas y aplicaciones, incluyendo gestión de archivos, notificaciones, seguridad, tablas básicas y servicios de seguros.
Expone operaciones REST para:
- Consulta de tablas básicas del sistema
- Gestión de códigos OTP (One-Time Password) y validación
- Envío de notificaciones por email y configuración SMTP
- Almacenamiento y recuperación de archivos en Azure Blob Storage y File Shares
- Consulta de servicios de seguros (frecuencias de pago, coberturas, productos)
- Registro de auditoría y trazabilidad de transacciones
- Encriptación y cifrado de documentos PDF
- Gestión de documentos de pólizas firmadas electrónicamente
La API actúa como una System API (SAPI), gestionada desde MuleSoft Anypoint Platform.
🌐 Información Básica
- Nombre de la API: cs-utilities-system-api-services
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- Runtime: Mule 4.x
- Tipo: System API
- URL Base QA:
https://utilities-system-api-qa.us-e1.cloudhub.io/api/ - Protocolo: HTTPS / REST
- Formato de Datos: JSON, application/octet-stream
🔐 Autenticación
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 en las siguientes plataformas:
- 🔗 MuleSoft Exchange – cs-utilities-system-api-services https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
- 🔗 Portal Público FGS https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
📋 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 |
|---|---|---|
| GET | /Utilities/v1/basicTables/{action} | Consultar tablas básicas por acción |
| GET | /Utilities/v1/basicTables/{action}/{id} | Consultar tabla básica específica por ID |
| POST | /Utilities/v1/messaging/sendEmail | Enviar correo electrónico |
| GET | /security/otpcode | Generar código OTP |
| POST | /security/otpcode/validate | Validar código OTP |
| GET | /notification/email/smtp | Obtener configuración del servidor SMTP |
| POST | /insurance/issuing-of-policy/save | Guardar transacción de emisión de póliza |
| GET | /insurance/life/rates/payment-freq | Consultar frecuencias de pago por canal y producto |
| GET | /insurance/home/combos-coverages | Consultar coberturas combinadas por producto |
| GET | /insurance/channel/product | Consultar productos por canal de venta |
| POST | /files/shares | Cargar archivo a Azure File Shares |
| GET | /files/shares | Descargar archivo desde Azure File Shares |
| POST | /files/blobs | Cargar archivo a Azure Blob Storage |
| GET | /files/blobs | Descargar archivo desde Azure Blob Storage |
| GET | /claims | Consultar pólizas asociadas a un reclamo |
| POST | /cosmos/query | Ejecutar consulta en Cosmos DB |
| POST | /web-api/report-use/register-data | Registrar información de uso en Knowledge Management |
| POST | /register-audit-log | Registrar log de auditoría en Portal Clientes |
| GET | /gateway-services-azure/product-information | Obtener información de productos |
| POST | /gateway-services-azure/storageDocumentPolicySigned | Almacenar documento de póliza firmado |
| POST | /gateway-services-azure/registry-encrypt | Encriptar/desencriptar registro |
| POST | /encryptPdfWithPassword | Encriptar PDF con contraseña |
⚠️ 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ódigo | Estado | Descripción |
|---|---|---|
| 200 | OK | Solicitud procesada correctamente |
| 400 | Bad Request | Solicitud inválida o mal formada |
| 401 | Unauthorized | Credenciales inválidas o ausentes |
| 403 | Forbidden | Client ID sin permisos |
| 404 | Not Found | Recurso no encontrado |
| 405 | Method Not Allowed | Método HTTP no permitido |
| 415 | Unsupported Media Type | Tipo de contenido no soportado |
| 429 | Too Many Requests | Límite de solicitudes excedido |
| 500 | Internal Server Error | Error interno inesperado |
| 503 | Service Unavailable | Servicio temporalmente no disponible |
| 504 | Gateway Timeout | Tiempo de espera agotado |
📞 Soporte
Para soporte técnico o incidencias relacionadas con la integración:
Coordinación de Servicios de Integración y Aplicaciones
📅 Información Adicional
Documentación creada en Febrero 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 servicios utilitarios corporativos.