cs-portal-liferay-xapi
home
🛡️ cs-portal-liferay-xapi
La API cs-portal-liferay-xapi provee una solución integral para la interacción con el Portal Liferay, permitiendo la gestión completa de afiliados, contratos, tarjetas, cursos e inscripciones.
Expone operaciones REST para:
- Consulta de contratos de afiliados con validación de fecha de nacimiento
- Generación de tarjetas para trabajadores dependientes e independientes
- Emisión de certificados de membresía de afiliados
- Gestión de cursos disponibles por plataforma y sector económico
- Inscripción de trabajadores en cursos seleccionados
- Consulta de información paramétrica de plataformas y sectores económicos
La API actúa como una Experience API (XAPI), gestionada desde MuleSoft Anypoint Platform.
🌐 Información Básica
- Nombre de la API: cs-portal-liferay-xapi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- Tipo: Experience API
- URL Base QA:
https://cs-portal-liferay-xapi-qa-v1.us-e1.cloudhub.io/api/ - URL Base Producción:
https://cs-portal-liferay-xapi-prod-v1.us-e1.cloudhub.io/api/ - Protocolo: HTTPS / REST
- Formato de Datos: JSON
🔐 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.
- Headers requeridos:
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.
- Header requerido:
Header Invoker
- Header requerido:
invoker: JSON con información del usuario y aplicación
- Formato:
{ "application": "Portal", "addressIPUser": "192.168.80.13", "loginUser": "usuario", "userName": "Nombre Usuario" }
- Header requerido:
Todos los 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-portal-liferay-xapi 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 | /service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber} | Obtener contratos de afiliado usando fecha de nacimiento |
| GET | /service-liferay/affiliate/card/dependent/{idTypeIdentification}/{documentNumber} | Obtener tarjeta para trabajador dependiente |
| GET | /service-liferay/affiliate/card/independent/{idTypeIdentification}/{documentNumber} | Obtener tarjeta para trabajador independiente |
| GET | /service-liferay/affiliate/card/certificate/{idTypeIdentification}/{documentNumber} | Obtener certificado de membresía de afiliado |
| GET | /admin-courses/courses/course | Obtener cursos disponibles |
| GET | /admin-courses/courses/platform | Obtener plataformas de cursos disponibles |
| GET | /admin-courses/courses/courses-economic-sector | Obtener cursos por sector económico |
| GET | /admin-courses/courses/courses-detail | Obtener información detallada del curso |
| GET | /parametric/platform | Obtener información de plataforma paramétrica |
| GET | /parametric/economic-sector | Obtener plataforma por sector económico |
| POST | /enrollment/enroll-worker-in-course | Inscribir trabajador en curso seleccionado |
| GET | /enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber} | Obtener información general de inscripción para un trabajador |
⚠️ 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
Correo electrónico: epalma@fgs.co
📅 Información Adicional
Documentación creada en Enero 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 el Portal Liferay.