cs-portal-liferay-xapi icon

cs-portal-liferay-xapi

1.0.x
(0 reviews)
CS Portal Liferay XAPI es una API RESTful que permite interacción segura con el portal Liferay, brindando acceso a contratos de afiliados, certificados de afiliación, detalles de cursos y servicios de inscripción, facilitando la gestión de información.

🏠 Inicio - 🛡️ cs-portal-liferay-xapi

System API que interactúa con el Portal Liferay.

Proporciona endpoints para gestionar afiliados, contratos, tarjetas, cursos e inscripciones.

🌐 Información Base

  • Título de la API: cs-portal-liferay-xapi
  • Versión: 1.0.0
  • URL Base: https://cs-portal-liferay-xapi-{env}-v1.us-e1.cloudhub.io/api
  • Entornos: dev, qa, prod

🚀 Primeros Pasos

  1. Autenticación: Esta API utiliza OAuth 2.0. Asegúrate de enviar un client_id válido y un token Bearer.
  2. Encabezados:
    -H "client_id: TU_CLIENT_ID"
-H "Authorization: Bearer TU_ACCESS_TOKEN"
-H "invoker: { \"application\": \"Portal\", \"addressIPUser\": \"192.168.80.13\", \"loginUser\": \"Cristian1997\", \"userName\": \"Cristian Cardona\" }"

📍 Endpoints Disponibles

MétodoEndpointDescripciónEnlace de Exchange
GET/service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber}Obtener contratos de afiliado usando fecha de nacimientoVer detalles
GET/service-liferay/affiliate/card/dependent/{idTypeIdentification}/{documentNumber}Obtener tarjeta para trabajador dependienteVer detalles
GET/service-liferay/affiliate/card/independent/{idTypeIdentification}/{documentNumber}Obtener tarjeta para trabajador independienteVer detalles
GET/service-liferay/affiliate/card/certificate/{idTypeIdentification}/{documentNumber}Obtener certificado de membresía de afiliadoVer detalles
GET/admin-courses/courses/courseObtener cursos disponiblesVer detalles
GET/admin-courses/courses/platformObtener plataformas de cursos disponiblesVer detalles
GET/admin-courses/courses/courses-economic-sectorObtener cursos por sector económicoVer detalles
GET/admin-courses/courses/courses-detailObtener información detallada del cursoVer detalles
GET/parametric/platformObtener información de plataforma paramétricaVer detalles
GET/parametric/economic-sectorObtener plataforma por sector económicoVer detalles
POST/enrollment/enroll-worker-in-courseInscribir trabajador en curso seleccionadoVer detalles
GET/enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber}Obtener información general de inscripción para un trabajadorVer detalles

📤 Ejemplo de Solicitud

curl -X GET "https://cs-portal-liferay-xapi-dev-v1.us-e1.cloudhub.io/api/service-liferay/affiliate/contracts/CC/123456789?birthDate=1990-01-01" \
-H "client_id: TU_CLIENT_ID" \
-H "Authorization: Bearer TU_ACCESS_TOKEN" \
-H "invoker: { \"application\": \"Portal\", \"addressIPUser\": \"192.168.80.13\", \"loginUser\": \"Cristian1997\", \"userName\": \"Cristian Cardona\" }"

⚠️ Manejo de Errores

Se utilizan códigos de estado HTTP estándar para el manejo de errores:

  • 200 OK – La solicitud fue exitosa
  • 400 Bad Request – Parámetros faltantes o inválidos
  • 401 Unauthorized – Falló la autenticación
  • 404 Not Found – Endpoint o recurso no encontrado
  • 500 Internal Server Error – Error inesperado en el 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: Agosto 2025
  • Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en julio 2025 por epalma@fgs.co - Edna Nayibe Palma

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

Reviews