cs-utilities-system-api-services icon

cs-utilities-system-api-services

1.0.x
(0 reviews)
La API de Utilidades del Sistema ofrece acceso seguro a funciones clave como operaciones sobre tablas, mensajería, seguridad, gestión de archivos, servicios de seguros y procesamiento de reclamaciones, facilitando la administración eficiente del sistema

🛠cs-utilities-system-api-services

Esta API ofrece un amplio conjunto de utilidades y servicios de apoyo para la integración de aplicaciones y sistemas. Incluye endpoints para:

  • Consultas de tablas básicas y configuración
  • Servicios de mensajería por correo electrónico
  • Generación y validación de Contraseñas de Un Solo Uso (OTP)
  • Gestión de notificaciones y servidores SMTP
  • Operaciones de datos relacionados con seguros
  • Carga y descarga de archivos (archivos compartidos, blobs)
  • Consultas de reclamos y CosmosDB
  • Reportes de uso para aplicaciones web

Todos los servicios están asegurados vía OAuth 2.0 y siguen estándares comunes para integraciones robustas.

🌐 Información Base

  • Título de la API: system-utilities-api
  • Versión: 1.0.0
  • URL Base: https://utilities-system-api-{env}.us-e1.cloudhub.io/api/

🚀 Cómo Comenzar

  1. Autenticación: Asegúrate de tener un client_id válido y token Bearer OAuth 2.0.
  2. URL Base: Prefija todos los endpoints con la URL base.
  3. Encabezados: Usa los siguientes encabezados en tus solicitudes:-H "client_id: TU_CLIENT_ID"-H "Authorization: Bearer TU_ACCESS_TOKEN"-H "Content-Type: application/json"

📍 Endpoints Disponibles

MétodoEndpointDescripciónEnlace Exchange
GET/Utilities/v1/basicTables/(action)Consultar tablas básicas por acciónVer en Exchange
GET/Utilities/v1/basicTables/(action)/(id)Consultar detalle de tabla básica por IDVer en Exchange
POST/file/shareCompartir un archivoVer en Exchange
POST/files/blobsSubir blobs de archivosVer en Exchange
POST/files/sharesCrear un recurso compartido de archivosVer en Exchange
GET/files/sharesObtener recursos compartidos de archivosVer en Exchange
GET/files/blobsObtener blobs de archivosVer en Exchange
GET/claimsConsultar reclamosVer en Exchange
POST/cosmos/queryEjecutar consulta en Cosmos DBVer en Exchange
GET/security/otpcodeGenerar código OTPVer en Exchange
GET/notification/email/smtpEnviar notificación vía SMTPVer en Exchange
POST/security/otpcode/validateValidar código OTPVer en Exchange
GET/insurance/life/rates/payment-freqObtener frecuencia de pago de seguros de vidaVer en Exchange
GET/insurance/home/combos-coveragesObtener coberturas y combos de seguros de hogarVer en Exchange
GET/insurance/channel/productObtener productos disponibles por canalVer en Exchange
POST/web-api/report-use/register-dataRegistrar uso de reportes en Web APIVer en Exchange
POST/insurance/issuing-of-policy/saveEmitir póliza de seguroVer en Exchange
POST/register-audit-logRegistrar auditoría de logsVer en Exchange
GET/gateway-services-azure/product-informationConsultar información de producto en AzureVer en Exchange
POST/encryptPdfWithPasswordEncriptar PDF con contraseñaVer en Exchange
POST/gateway-services-azure/storageDocumentPolicySignedGuardar documento de póliza firmada en AzureVer en Exchange
POST/gateway-services-azure/registry-encryptRegistrar documento encriptado en AzureVer en Exchange

📤 Ejemplo de Solicitud (Genérico)

curl -X POST "https://utilities-system-api-{env}.us-e1.cloudhub.io/api/<endpoint>" \
-H "client_id: TU_CLIENT_ID" \
-H "Authorization: Bearer TU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "key": "value" }'

Reemplaza <endpoint> y la carga útil según sea necesario para el recurso específico.

⚠️ Manejo de Errores

Esta API sigue códigos de estado HTTP estándar para todas las respuestas:

  • 200 OK – La solicitud fue procesada exitosamente
  • 400 Bad Request – Parámetros inválidos o faltantes
  • 401 Unauthorized – Autenticación fallida
  • 404 Not Found – El endpoint o recurso especificado no existe
  • 500 Internal Server Error – Error inesperado del lado del servidor

📞 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 actualizada en septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API system-utilities-api

Reviews