cs-apolo-sapi-v3
La API cs-apolo-sapi-v3 provee una solución integral para la gestión operativa de empresas, trabajadores, centros de trabajo, productos, contratos, novedades y servicios de salud ARL, permitiendo la integración controlada con el sistema APOLO.
🛡️ cs-apolo-sapi-v3
La API cs-apolo-sapi-v3 provee una solución integral para la gestión operativa de empresas, trabajadores, centros de trabajo, productos, contratos, novedades y servicios de salud ARL, permitiendo la integración controlada con el sistema APOLO a través de servicios corporativos internos.
Expone operaciones REST para:
- Gestión de empresas: consulta, actualización, vinculación y configuración de contratos
- Administración de centros de trabajo: creación, novedades, cierres y aprobaciones
- Control de productos y contratos: autorización, desautorización y consulta
- Gestión de períodos de cierre y retiros retroactivos
- Servicios de salud: afiliaciones ARL, evaluaciones médicas, incapacidades y autorizaciones
- Catálogos y soporte: tipos, catálogos geográficos, ocupacionales y de riesgo
- Novedades masivas y procesamiento de cargas
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-v3
- Versión: v1
- Plataforma: MuleSoft Anypoint Platform
- Runtime: Mule 4.x
- Tipo: System API
- URL Base QA:
https://cs-apolo-sapi-qa-v3.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:
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:
- 🔗 MuleSoft Exchange – cs-apolo-sapi-v3 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:
- Navegar en el menú izquierdo de la documentación
- Expandir la sección "Summary"
- Seleccionar el método específico que requiere consultar
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| DELETE | /remove-exceptions-from-news-for-the-company | Eliminar excepciones de novedades para la empresa |
| DELETE | /remove-product-by-contract | Eliminar producto por contrato |
| DELETE | /remove-record-control-massive-affiliation | Eliminar registro de control de afiliación masiva |
| GET | /check-status-process-generation-support-affiliation | Verificar estado del proceso de generación de soporte de afiliación |
| GET | /contract-exceptions-news | Excepciones de novedades del contrato |
| GET | /contract-states | Estados de contrato |
| GET | /count-workers-by-company | Consultar contador de trabajadores por empresa |
| GET | /create-new-closing-work-center-with-workers | Crear nuevo cierre de centro de trabajo con trabajadores |
| GET | /create-new-identification | Crear nueva identificación |
| GET | /create-retroactive-closing-period | Crear período de cierre retroactivo |
| GET | /exworker-disability-payment | Consultar incapacidades pagadas para extrabajadores |
| GET | /get-disability-payments | Consultar pagos de incapacidades |
| GET | /load-zone-types | Cargar tipos de zona |
| GET | /medical-evaluations | Obtener evaluaciones médicas |
| GET | /obtain-all-contracts-Worker | Obtener todos los contratos del trabajador |
| GET | /obtain-applications-company-work-centers | Obtener solicitudes de centros de trabajo de la empresa |
| GET | /obtain-attachments-by-type-process | Obtener adjuntos por tipo de proceso |
| GET | /obtain-body-parts | Obtener partes del cuerpo |
| GET | /obtain-branches-by-regional | Obtener sucursales por regional |
| GET | /obtain-closing-period-of-operations | Obtener período de cierre de operaciones |
| GET | /obtain-companies-holding-by-identification | Obtener empresas del holding por identificación |
| GET | /obtain-company | Consultar empresa por contrato e identificación |
| GET | /obtain-company-by-contract-number | Obtener empresa por número de contrato |
| GET | /obtain-company-niches | Obtener nichos de empresa |
| GET | /obtain-company-not-linked-by-id | Obtener empresa no vinculada por identificación |
| GET | /obtain-configuration-parameter | Obtener parámetro de configuración |
| GET | /obtain-contacts | Obtener contactos |
| GET | /obtain-contract-states | Obtener estados de contrato |
| GET | /obtain-contract-type | Obtener tipo de contrato |
| GET | /obtain-detail-application-center-work | Obtener detalle de solicitud de centro de trabajo |
| GET | /obtain-diagnosed-by | Obtener diagnosticado por |
| GET | /obtain-diagnoses | Obtener diagnósticos |
| GET | /obtain-economic-activities-by-niche | Obtener actividades económicas por nicho |
| GET | /obtain-events-by-person | Obtener eventos por persona |
| GET | /obtain-files-sent-retroactive-withdrawal-closing | Obtener archivos enviados de retiro retroactivo de cierre |
| GET | /obtain-indicatives-by-state | Obtener indicativos por departamento |
| GET | /obtain-job-center-creation-request | Obtener solicitud de creación de centro de trabajo |
| GET | /obtain-main-headquarter | Obtener sede principal |
| GET | /obtain-niches | Obtener nichos |
| GET | /obtain-paid-returns | Obtener devoluciones pagadas |
| GET | /obtain-products | Obtener productos |
| GET | /obtain-products-by-company | Obtener productos por empresa |
| GET | /obtain-products-by-contract | Obtener productos por contrato |
| GET | /obtain-regional | Obtener regional |
| GET | /obtain-retroactive-withdrawals-closing | Obtener retiros retroactivos de cierre |
| GET | /obtain-retroActive-withdrawals-theDay-closing | Obtener retiros retroactivos del día de cierre |
| GET | /obtain-specific-business-types | Obtener tipos de negocio específicos |
| GET | /obtain-types-employment-link | Obtener tipos de vínculo laboral |
| GET | /obtain-types-employment-link-worker | Obtener tipos de vínculo laboral del trabajador |
| GET | /obtain-types-habitual-occupation | Obtener tipos de ocupación habitual |
| GET | /obtain-types-injury | Obtener tipos de lesión |
| GET | /obtain-types-risk-factors-disease | Obtener tipos de factores de riesgo de enfermedad |
| GET | /obtain-work-center-approval-report | Obtener reporte de aprobación de centro de trabajo |
| GET | /support-new-worker | Obtener soporte de nuevo trabajador |
| GET | /support-news-headquarters-change-address | Soporte de novedad de sede – cambio de dirección |
| GET | /support-novelty-headquarters-change-fax | Soporte de novedad de sede – cambio de fax |
| GET | /support-novelty-headquarters-change-telephone | Soporte de novedad de sede – cambio de teléfono |
| GET | /types-news-headquarters | Tipos de novedades de sede |
| GET | /v1/get-company-worker-centers | Obtener centros de trabajo de la empresa |
| GET | /v1/get-company-workers | Obtener trabajadores de la empresa |
| GET | /work-center-table-support-by-company | Tabla de soporte de centros de trabajo por empresa |
| GET | /worker-salary | Consultar salario del trabajador |
| POST | /allow-product-by-contract | Autorizar producto por contrato |
| POST | /allow-product-by-massive-contract | Autorizar producto por contrato masivo |
| POST | /check-bulk-upload-status | Verificar estado de carga masiva |
| POST | /covid-survey-questions | Preguntas de encuesta COVID |
| POST | /covid-survey-responses | Respuestas de encuesta COVID |
| POST | /create-novelty-change-basic-data-center-work | Crear novedad de cambio de datos básicos de centro de trabajo |
| POST | /create-novelty-closure-center-work | Crear novedad de cierre de centro de trabajo |
| POST | /create-request-new-work-center-company | Crear solicitud de nuevo centro de trabajo de empresa |
| POST | /customers/identity-data | Registrar datos de identidad del cliente |
| POST | /disallow-product-by-contract | Desautorizar producto por contrato |
| POST | /disallow-product-by-massive-contract | Desautorizar producto por contrato masivo |
| POST | /exworker-disability-payment-certificate | Generación de comprobante de giro de incapacidad para extrabajadores |
| POST | /generation-certificate-payment-of-disabilities | Generación de certificado de pago de incapacidades |
| POST | /health-service/arlEmployerTransfer/destination-ARL/transferNotification | Notificación de traslado ARL destino |
| POST | /health-service/arlEmployerTransfer/origin-ARL | Traslado de empleador ARL origen |
| POST | /health-service/employer/beginningEmploymentRelationship | Inicio de relación laboral |
| POST | /health-service/employer/membership-Arl | Afiliación de empleador a ARL |
| POST | /health-service/employer/retractionTransferOrEmployerAffiliationArl | Retractación, traslado o afiliación de empleador a ARL |
| POST | /health-service/employer/terminationEmploymentRelationship | Terminación de relación laboral |
| POST | /health-service/headquarters/noveltyNotification | Notificación de novedad de sede |
| POST | /health-service/workCenter/novelties | Novedades de centro de trabajo |
| POST | /health-service/workCenter/variationWorkCenterforDependentWorkersAndStudents | Variación de centro de trabajo para trabajadores dependientes y estudiantes |
| POST | /obtain-companies-by-filters-for-authorization | Obtener empresas por filtros para autorización |
| POST | /obtain-headquarters-with-responsible-apolo | Obtener sedes con responsable en Apolo |
| POST | /reprocess-massive-new | Reprocesar novedad masiva |
| POST | /reprocess-massive-news-pending-filing | Reprocesar novedades masivas pendientes de radicación |
| POST | /save-contacts | Guardar contactos |
| PUT | /invoice-reserve-details | Actualizar detalles de reserva de factura |
| PUT | /inovice-reserve-headers | Actualizar encabezados de reserva de factura |
| PUT | /update-closing-period-retro-active | Actualizar período de cierre retroactivo |
| PUT | /update-company | Actualizar empresa |
| PUT | /update-company-exceptions | Actualizar excepciones de empresa |
| PUT | /update-data-company-resolution-ugpp | Actualizar datos de empresa resolución UGPP |
| PUT | /update-job-center-creation-request-status | Actualizar estado de solicitud de creación de centro de trabajo |
⚠️ 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
📅 Información Adicional
Documentación creada en Junio 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 operativa APOLO.