cs-credits-sapi

(0 reviews)

API de servicios de créditos que permite gestionar consultas de clientes y verificar el estado de seguros. Implementa endpoints RESTful con transformaciones de datos, manejo de errores y operaciones de validación.

🛡️ cs-credits-sapi

Esta API proporciona servicios especializados para la gestión de suscripciones de créditos y validación de seguros empresariales. Incluye endpoints para:

Verificación del estado de seguros y validaciones de crédito
Actualización de información de suscripciones por ID
Procesamiento de solicitudes de crédito con identificaciones
Transformación de datos entre sistemas backend
Orquestación de servicios de validación financiera
Manejo de identificaciones y documentación
Operaciones de verificación de riesgo crediticio

Todos los servicios se exponen a través de una arquitectura robusta con manejo de errores centralizado y transformaciones de datos optimizadas para alta disponibilidad y performance.

🌐 Información Base

Título de la API: cs-credits-sapi
Versión: 1.0.0-SNAPSHOT
Plataforma: MuleSoft Anypoint Platform
Runtime: Mule 4.4.0
Java Version: 17
URL Base Producción: https://cs-credits-sapi-prod.us-e1.cloudhub.io/api/
URL Base QA: https://cs-credits-sapi-qa.us-e1.cloudhub.io/api/
Protocolo: REST/HTTPS
Formato de Datos: JSON
Autenticación: OAuth 2.0 + Client ID

🚀 Cómo Comenzar

Autenticación: Asegúrate de tener el client_id requerido y el token Bearer OAuth 2.0 para 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 "Authorization: Bearer TU_ACCESS_TOKEN"
-H "X-Correlation-ID: TU_CORRELATION_ID"  # Opcional pero recomendado para trazabilidad

🚀 Cómo Consumir

Puedes acceder y consumir esta API a través de las siguientes plataformas:

🔗 MuleSoft Exchange (Credits API)
🔗 Portal Público FGS

📍 Endpoints Disponibles

Método	Endpoint	Descripción
POST	`/api/deceval/createDrawer`	Crear giradores en el sistema DECEVAL
POST	`/api/deceval/promissory-notes`	Crear pagarés deceval
POST	`/api/deceval/promissory-notes/sign`	Firmar pagarés deceval
POST	`/api/deceval/promissory-notes/{noteId}/void`	Anular pagarés deceval
POST	`/api/deceval/promissory-notes/{noteId}/cancel`	Cancelar pagarés deceval
GET	`/api/deceval/promissory-notes/query`	Consultar pagarés deceval

⚠️ 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 en el request	Revisar estructura del JSON y campos requeridos
`401`	🔒 Unauthorized	Autenticación fallida	Token expirado o client_id inválido	Renovar token de autenticación
`403`	🚫 Forbidden	Sin permisos suficientes	Client_id sin permisos para el endpoint	Verificar permisos asignados al client_id
`404`	🔍 Not Found	Recurso no encontrado	Cliente o solicitud de crédito inexistente	Verificar el ID proporcionado
`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 o servicios backend	Contactar soporte técnico con correlation ID
`503`	🛠️ Service Unavailable	Servicio temporalmente no disponible	Mantenimiento o sobrecarga del sistema	Reintentar más tarde

📞 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 y actualizada en Noviembre 2025 para la API cs-credits-sapi

📋 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 y rota tokens regularmente.

⚡ Rendimiento: Esta API está optimizada para manejar hasta 1000 requests por minuto. Para cargas superiores, contacta al equipo de soporte para escalamiento.

home