cs-apolo-sapi icon

cs-apolo-sapi

(0 reviews)
cs-apolo-sapi brinda acceso integral a la base de datos APOLO, con endpoints para certificaciones de accidentes, gestión de trabajadores, afiliaciones, contratos e informes financieros, permitiendo interacción segura con datos de sedes y empleo.

home

🛡️ cs-apolo-sapi

La API cs-apolo-sapi provee acceso controlado a los datos del Sistema General de Riesgos Laborales desde la base de datos APOLO, permitiendo la gestión de trabajadores, empresas, contratos, afiliaciones y accidentalidad laboral.

Expone operaciones REST para:

  • Gestión de trabajadores dependientes e independientes
  • Administración de empresas y contratos laborales
  • Procesamiento de afiliaciones al sistema de riesgos laborales
  • Registro y consulta de accidentes de trabajo
  • Generación de certificaciones y documentos oficiales
  • Consulta de información geográfica y catálogos del sistema
  • Gestión de centros de trabajo y sedes empresariales
  • Integración con servicios Liferay (cursos, tarjetas, certificados)

La API actúa como una System API (SAPI), gestionada desde MuleSoft Anypoint Platform.


🌐 Información Básica

  • Nombre de la API: cs-apolo-sapi
  • Versión: 1.0.0
  • Plataforma: MuleSoft Anypoint Platform
  • Runtime: Mule 4.x
  • Tipo: System API
  • URL Base QA:https://cs-apolo-sapi-qa-v1.us-e1.cloudhub.io/api/
  • URL Base PROD:https://cs-apolo-sapi-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:

  1. Client ID Enforcement

    • Headers requeridos:

      • client_id
      • client_secret
    • Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
  2. 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:

📋 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étodoEndpointDescripción
GET/accident/rate/certificationObtener certificación de tasa de accidentalidad
POST/accident/rate/certification/annualGenerar certificación anual de tasa de accidentalidad
GET/accident/rate/certification/workerObtener certificación de tasa de accidentalidad por trabajador
POST/accident/rate/certification/disability/workerCertificación de incapacidad por accidente de trabajador
POST/accidentsObtener listado de accidentes
GET/accidents/headquartersConsultar accidentes por sede
POST/affiliate/certification/letter/dependentCarta de certificación de afiliado dependiente
POST/affiliate/certification/letter/independentCarta de certificación de afiliado independiente
POST/affiliate/certification/annex/dependentAnexo de certificación de afiliado dependiente
POST/affiliate-certification-annex-independentAnexo de certificación de afiliado independiente
GET/affiliate/certification/abroad/dependentCertificado de asistencia en el exterior para dependiente
POST/affiliate/certification/special/dependentCertificación especial de afiliación de dependiente
POST/affiliate/certification/special/independentCertificación especial de afiliación de independiente
POST/affiliations-contractsCrear contrato de afiliación
GET/affiliate/ARPObtener información ARP del afiliado
GET/at/employer/contracting/reportReporte de contratación de empleador AT
DELETE/appointment-schedulingCancelar cita programada
POST/appointment-schedulingCrear cita programada
POST/cancellation-independent-withdrawalCancelación de retiro independiente
GET/certificate-payment-return-contributionsCertificado de pago y devolución de aportes
GET/citiesListar ciudades por departamento
GET/cities/contract/{idContract}Obtener ciudades por contrato
POST/collection-report-worker-o-massReporte de recaudo por trabajador o masivo
GET/companyConsultar empresa por identificación
GET/companies/{id}Consultar empresa por número de identificación
GET/companies/policiesObtener pólizas de empresas
GET/companies/contracts/{id}Obtener contratos por ID de empresa
POST/companies/contracts/member-by-day-of-birthObtener miembro por fecha de nacimiento
GET/companies/workersObtener trabajadores de empresas
POST/companies/workers/contact-informationCrear información de contacto de trabajadores
PUT/companies/workers/contact-informationActualizar información de contacto de trabajadores
GET/companies/headquarters/{contractConsecutive}Consultar sedes de empresa por contrato
POST/companies/headquarters/certification/currentCertificación actual de sede empresarial
GET/contactsObtener contactos
GET/contract-typesObtener tipos de contrato
GET/contracts/work-centers/{contractConsecutive}Consultar centros de trabajo por contrato
GET/contributor-types-worker-typeTipos de cotizante por tipo de trabajador
POST/create-dependent-workerCrear trabajador dependiente
POST/create-independent-workerCrear trabajador independiente
GET/create-new-change-Afp-independentCambiar AFP de trabajador independiente
GET/create-new-change-independent-emailCambiar email de trabajador independiente
POST/create-new-change-independent-identificationCambio de identificación de independiente
GET/create-new-independent-IBC-changeCambiar IBC de trabajador independiente
POST/create-novelty-cancellation-entry-independentCancelación de ingreso de independiente
POST/create-novelty-change-city-independentCambio de ciudad de independiente
GET/create-novelty-change-independent-cellPhoneCambiar celular de trabajador independiente
POST/create-novelty-change-Eps-independentCambio de EPS de independiente
POST/create/new/change/date/birth/independentCambio de fecha de nacimiento de independiente
POST/current/dependent-workerCertificación vigente de trabajador dependiente
POST/current/independent-workerCertificación vigente de trabajador independiente
GET/current-legal-minimum-wageObtener salario mínimo legal vigente
GET/customersObtener clientes
GET/departments/contract/{idContract}Obtener departamentos por contrato
POST/dependent-work-accidentCrear accidente de trabajo dependiente
POST/dependent-workerCrear trabajador dependiente (contingencia Jotform)
POST/dependent-worker/massiveCrear trabajador dependiente masivo (contingencia Jotform)
GET/dependent-workers/{id}Obtener datos de trabajador dependiente
GET/dependent-workers-filter/{id}Obtener datos filtrados de trabajador dependiente
GET/economic/benefit/reportReporte de beneficios económicos
POST/extension/validity/independentExtensión de validez de trabajador independiente
POST/generation-certificate-payment-of-disabilitiesGeneración de certificado de pago de incapacidades
GET/get-support-newsObtener soporte de novedades
GET/headquartersObtener sedes
GET/headquarters/relationshipObtener relación de sedes
GET/history/news/dependentHistorial de novedades de dependiente
GET/history/news/independentHistorial de novedades de independiente
POST/independent-name-changeCambio de nombre de trabajador independiente
POST/independent-workerCrear trabajador independiente (contingencia Jotform)
POST/independent-worker/massiveCrear trabajador independiente masivo (contingencia Jotform)
GET/independent-workers/{id}Obtener datos de trabajador independiente
GET/indemnitiesObtener indemnizaciones
GET/info-financial-workerObtener información financiera del trabajador
PUT/info-financial-workerActualizar información financiera del trabajador
GET/load-types-modalityObtener tipos de modalidad
GET/news/companiesObtener novedades de empresas
GET/news/deltas/headquartersObtener novedades delta de sedes
GET/news/earns-income/dependentNovedades de ingresos de dependiente
GET/news/earns-income/independentNovedades de ingresos de independiente
GET/news/headquartersObtener novedades de sedes
GET/news/portalObtener novedades del portal
GET/news/types/workers/independent/filterFiltrar tipos de novedades de trabajadores independientes
GET/obtain-accidents-by-location-reportReporte de accidentes por ubicación
GET/obtain-AFP-TypesObtener tipos de AFP
GET/obtain-all-citiesObtener todas las ciudades
GET/obtain-ARP-TypesObtener tipos de ARP
GET/obtain-case-at-client-portalObtener caso AT en portal cliente
GET/obtain-case-ep-client-portalObtener caso EP en portal cliente
POST/obtain-company-causal-statusObtener estado causal de empresa
GET/obtain-company-work-centersObtener centros de trabajo de empresa
GET/obtain-Contracts-Per-AffiliateContratos por afiliado
GET/obtain-day-typeObtener tipo de día
GET/obtain-departmentsObtener departamentos
POST/obtain-dependent-workers-membershipObtener membresía de trabajadores dependientes
GET/obtain-disability-states-report-economic-benefitsEstados de incapacidad y beneficios económicos
GET/obtain-economic-activitiesObtener actividades económicas
GET/obtain-EPS-TypesObtener tipos de EPS
POST/obtain-events-per-workerObtener eventos por trabajador
GET/obtain-Gender-TypesObtener tipos de género
GET/obtain-list-affiliation-independentObtener listado de afiliaciones independientes
GET/obtain-occupational-disease-filingsObtener radicaciones de enfermedad laboral
GET/obtain-Work-Centers-Number-Of-WorkersObtener centros de trabajo con número de trabajadores
GET/obtain-zone-TypesObtener tipos de zona
GET/obtain/accident/reportObtener reporte de accidente
GET/obtain/casesObtener casos
GET/obtain/certification/company/membershipCertificación de membresía de empresa
GET/other/news/dependentOtras novedades de dependiente
GET/other/news/independentOtras novedades de independiente
GET/paid/returnsObtener devoluciones pagadas
GET/participantsObtener participantes
POST/pcc/file-worker-contactHabeas Data - Términos y condiciones
GET/policiesObtener pólizas
GET/providersObtener proveedores
POST/pymes-affiliationsCrear afiliación PyME
GET/pymes-affiliations/{affiliation_id}Obtener afiliación PyME por ID
POST/pymes-affiliations/{affiliation_id}/returnsCrear devolución de afiliación PyME
GET/quotes/typeObtener tipos de cotización
GET/quoteTypesByWorkerTypeTipos de cotización por tipo de trabajador
GET/report-disease-labor-no-qualifiedReporte de enfermedad laboral no calificada
POST/retired-dependent-workers-cancelledRetirar trabajadores dependientes cancelados
POST/retired-independent-workers-cancelledRetirar trabajadores independientes cancelados
GET/service-liferay/admin-courses/courses/courseObtener cursos
GET/service-liferay/admin-courses/courses/courses-detailObtener detalle de cursos
GET/service-liferay/admin-courses/courses/courses-economic-sectorObtener cursos por sector económico
GET/service-liferay/admin-courses/courses/platformObtener cursos por plataforma
GET/service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber}Contratos de afiliado por identificación
GET/service-liferay/affiliate/contracts/card/certificate/{idTypeIdentification}/{documentNumber}Certificado de tarjeta de afiliado
GET/service-liferay/affiliate/contracts/card/dependent/{idTypeIdentification}/{documentNumber}Tarjeta de afiliado dependiente
GET/service-liferay/affiliate/contracts/card/independent/{idTypeIdentification}/{documentNumber}Tarjeta de afiliado independiente
POST/service-liferay/enrollment/enroll-worker-in-courseInscribir trabajador en curso
GET/service-liferay/enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber}Información general de inscripción
GET/service-liferay/parametric/economic-sectorObtener sectores económicos
GET/service-liferay/parametric/platformObtener plataformas
GET/special-agreementObtener convenio especial
GET/subsidiary-arp/{id}Obtener subsidiaria ARP
GET/subtypes/contributor-type-workerSubtipos de cotizante por tipo de trabajador
GET/type-identificactionObtener tipos de identificación
GET/types/affiliatesTipos de afiliados
GET/v2/companies/contracts/{id}Obtener contratos por ID de empresa (v2)
POST/v2/pymes-affiliations/{affiliation_id}/returnsCrear devolución de afiliación PyME (v2)
GET/verify-disability-proofVerificar comprobante de incapacidad
POST/workers/dependen/affiliationAfiliación de trabajador dependiente
POST/workers/dependent/affiliationAfiliación de trabajador dependiente
POST/workers/dependent/affiliation/certificatedCertificación de afiliación dependiente
POST/workers/dependent/certification/affiliationCertificación de afiliación de trabajador dependiente
GET/workers/dependent/coverageObtener cobertura de trabajador dependiente
GET/workers/dependent/dataDatos de trabajadores dependientes
POST/workers/independent/affiliationAfiliación de trabajador independiente
POST/workers/independent/certification/affiliationCertificación de afiliación independiente
GET/workers/independent/coverageCobertura de trabajador independiente
GET/workplaceObtener puestos de trabajo
GET/workdayObtener jornadas laborales

⚠️ Manejo de Errores

La API utiliza códigos HTTP estándar para indicar el resultado del procesamiento de las solicitudes.

CódigoEstadoDescripción
200OKSolicitud procesada correctamente
400Bad RequestSolicitud inválida o mal formada
401UnauthorizedCredenciales inválidas o ausentes
403ForbiddenClient ID sin permisos
404Not FoundRecurso no encontrado
405Method Not AllowedMétodo HTTP no permitido
415Unsupported Media TypeTipo de contenido no soportado
429Too Many RequestsLímite de solicitudes excedido
500Internal Server ErrorError interno inesperado
503Service UnavailableServicio temporalmente no disponible
504Gateway TimeoutTiempo 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 la gestión del Sistema General de Riesgos Laborales desde la base de datos APOLO.


Reviews