cs-apolo-sapi-v2
La API provee una solución integral para la gestión de trabajadores independientes y dependientes, novedades, carnés, accidentes de trabajo, afiliaciones ARL y administración de usuarios en Colmena Gestión, permitiendo la integración controlada
🛡️ cs-apolo-sapi-v2
La API cs-apolo-sapi-v2 provee una solución integral para la gestión de trabajadores independientes y dependientes, novedades, carnés, accidentes de trabajo, afiliaciones ARL y administración de usuarios en Colmena Gestión, permitiendo la integración controlada con el sistema APOLO a través de servicios corporativos internos.
Expone operaciones REST para:
- Creación y retiro de trabajadores independientes y dependientes en el sistema ARL
- Gestión de novedades individuales y masivas para trabajadores independientes y dependientes
- Consulta y generación de carnés por distintos criterios de búsqueda
- Registro y consulta de accidentes de trabajo
- Administración de usuarios, roles y permisos en Colmena Gestión
- Generación de reportes de afiliación, auditoría, escarapela y certificados
- Integración con Power BI y módulos embebidos
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-v2
- Versión: v1
- Plataforma: MuleSoft Anypoint Platform
- Runtime: Mule 4.x
- Tipo: System API
- URL Base QA:
https://cs-apolo-sapi-qa-v2.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-v2 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
📍 Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| DELETE | /remove-user-colmena-management | Eliminar usuario de Colmena Gestión |
| GET | /basic-affiliate-report | Obtener reporte básico de afiliado |
| GET | /cards-by-date-new-independent-entry | Obtener carnés por fecha de nuevo ingreso independiente |
| GET | /cards-by-department-and-independent-city | Obtener carnés por departamento y ciudad independiente |
| GET | /consult-card-cover | Consultar carátula de carné |
| GET | /create-new-change-Afp-dependent | Crear nueva novedad de cambio de AFP dependiente |
| GET | /create-new-change-date-of-birth-dependent | Crear nueva novedad de cambio de fecha de nacimiento dependiente |
| GET | /create-new-change-dependent-email | Crear nueva novedad de cambio de correo electrónico dependiente |
| GET | /create-new-change-identification-dependent | Crear nueva novedad de cambio de identificación dependiente |
| GET | /create-new-change-salary-dependent | Crear nueva novedad de cambio de salario dependiente |
| GET | /create-novelty-change-dependent-cellPhone | Crear novedad de cambio de celular dependiente |
| GET | /files-sent-by-independent-date-ranges | Archivos enviados por rangos de fecha independiente |
| GET | /get-filed-accidents-dependent-worker | Obtener accidentes radicados del trabajador dependiente |
| GET | /get-filed-accidents-independent-worker | Obtener accidentes radicados del trabajador independiente |
| GET | /independent-workers-coverage | Cobertura de trabajadores independientes |
| GET | /obtain-accident-agent | Obtener agente del accidente |
| GET | /obtain-accident-forms | Obtener formularios de accidente |
| GET | /obtain-accident-reports-independent-company-up-to-date | Obtener reportes de accidentes de empresa independiente al día |
| GET | /obtain-accidents-filed-company-uptodate-dependent | Obtener accidentes radicados de empresa al día dependiente |
| GET | /obtain-ats-without-filing-dependent | Obtener ATs sin radicación dependiente |
| GET | /obtain-audit-report-colmena-gestion | Obtener reporte de auditoría de Colmena Gestión |
| GET | /obtain-card-by-city-state-dependent | Obtener carné por ciudad y estado dependiente |
| GET | /obtain-card-by-headquarters-dependent | Obtener carné por sede dependiente |
| GET | /obtain-card-by-headquarters-independent | Obtener carné por sede independiente |
| GET | /obtain-card-by-novelty-entry-date-dependent | Obtener carné por fecha de ingreso de novedad dependiente |
| GET | /obtain-card-report-records | Obtener registros de reporte de carnés |
| GET | /obtain-certified-report | Obtener reporte certificado |
| GET | /obtain-contracts-by-independent-worker | Obtener contratos por trabajador independiente |
| GET | /obtain-contracts-for-retired-independent-worker | Obtener contratos de trabajador independiente retirado |
| GET | /obtain-dependent-linker-types | Obtener tipos de vinculador dependiente |
| GET | /obtain-dependent-workers-By-WorkCenter | Obtener trabajadores dependientes por centro de trabajo |
| GET | /obtain-embedded-information | Obtener información embebida |
| GET | /obtain-independent-worker-by-consecutive-worker | Obtener trabajador independiente por consecutivo de trabajador |
| GET | /obtain-independent-worker-data | Obtener datos del trabajador independiente |
| GET | /obtain-list-of-unlegalized-accidents | Obtener listado de accidentes sin legalizar |
| GET | /obtain-novelties-bulk-pending-filing-dependent | Obtener novedades masivas pendientes de radicación dependiente |
| GET | /obtain-novelties-bulk-successful-filed-dependent | Obtener novedades masivas radicadas exitosamente dependiente |
| GET | /obtain-novelty-bulk-pending-filing-dependent | Obtener novedad masiva pendiente de radicación dependiente |
| GET | /obtain-novelty-bulk-pending-filing-independent | Obtener novedad masiva pendiente de radicación independiente |
| GET | /obtain-novelty-future-worker-dependent | Obtener novedad futura de trabajador dependiente |
| GET | /obtain-novelty-future-worker-independent | Obtener novedad futura de trabajador independiente |
| GET | /obtain-novelty-recent-worker-dependent | Obtener novedad reciente de trabajador dependiente |
| GET | /obtain-novelty-recent-worker-independent | Obtener novedad reciente de trabajador independiente |
| GET | /obtain-optional-report-fields | Obtener campos opcionales de reporte |
| GET | /obtain-report-rosette | Obtener reporte de escarapela |
| GET | /obtain-sites-accident | Obtener sitios de accidente |
| GET | /obtain-successful-income-file-independent | Obtener archivo de ingreso exitoso independiente |
| GET | /obtain-support-affiliate-dependent | Obtener soporte de afiliado dependiente |
| GET | /obtain-support-affiliation-independent | Obtener soporte de afiliación independiente |
| GET | /obtain-types-accidents | Obtener tipos de accidentes |
| GET | /obtain-user/colmena-gestion | Obtener usuario de Colmena Gestión |
| GET | /obtain-wrong-income-file-independent | Obtener archivo de ingreso erróneo independiente |
| GET | /obtain/registration/control/massive/report/affiliation | Obtener control de registro de reporte masivo de afiliación |
| GET | /support-new-extension-end-independent-validity | Obtener soporte de nueva extensión de fin de vigencia independiente |
| GET | /user-validation-complies-with-business-rules | Validación de usuario cumple con reglas de negocio |
| GET | /validate-user-registration-business-group | Validar registro de usuario en grupo empresarial |
| POST | /bulk-upload-independents | Carga masiva de independientes |
| POST | /bulk-upload-novelty-dependent | Carga masiva de novedades dependiente |
| POST | /bulk-upload-novelty-dependent-background | Carga masiva de novedades dependiente en segundo plano |
| POST | /bulk-upload-novelty-independent-background | Carga masiva de novedades independiente en segundo plano |
| POST | /create-independent-worker | Crear trabajador independiente |
| POST | /create-new-change-dependent-headquarters | Crear nueva novedad de cambio de sede dependiente |
| POST | /create-new-change-independent-headquarters | Crear nueva novedad de cambio de sede independiente |
| POST | /create-new-dependent-retirement | Crear nuevo retiro de dependiente |
| POST | /create-new-independent-retirement | Crear nuevo retiro de independiente |
| POST | /create-new-modification-start-date-dependent-coverage | Crear nueva modificación de fecha de inicio de cobertura dependiente |
| POST | /create-new-modification-start-date-independent-coverage | Crear nueva modificación de fecha de inicio de cobertura independiente |
| POST | /create-novelty-cancellation-entry-dependent | Crear novedad de cancelación de ingreso dependiente |
| POST | /create-novelty-cancellation-retirement-dependent | Crear novedad de cancelación de retiro dependiente |
| POST | /create-novelty-change-city-dependent | Crear novedad de cambio de ciudad dependiente |
| POST | /create-novelty-change-Eps-dependent | Crear novedad de cambio de EPS dependiente |
| POST | /create-novelty-change-journey-dependent | Crear novedad de cambio de jornada dependiente |
| POST | /create-novelty-change-locality-commune-dependent | Crear novedad de cambio de localidad/comuna dependiente |
| POST | /create-novelty-change-locality-commune-independent | Crear novedad de cambio de localidad/comuna independiente |
| POST | /create-novelty-change-names-dependent | Crear novedad de cambio de nombres dependiente |
| POST | /create-novelty-change-phone-dependent | Crear novedad de cambio de teléfono dependiente |
| POST | /create-novelty-change-phone-independent | Crear novedad de cambio de teléfono independiente |
| POST | /create-novelty-change-position-dependent | Crear novedad de cambio de cargo dependiente |
| POST | /create-novelty-change-work-center-dependents | Crear novedad de cambio de centro de trabajo dependientes |
| POST | /create-novelty-change-zone-dependent | Crear novedad de cambio de zona dependiente |
| POST | /create-novelty-change-zone-independent | Crear novedad de cambio de zona independiente |
| POST | /create-novelty-dependent-sex-change | Crear novedad de cambio de sexo dependiente |
| POST | /create-novelty-independent-sex-change | Crear novedad de cambio de sexo independiente |
| POST | /create-novelty-retroactive-retirement-individual-closing | Crear novedad de retiro retroactivo individual de cierre |
| POST | /create-novelty-retirement-retroactive-massive-closing | Crear novedad de retiro retroactivo masivo de cierre |
| POST | /create/new/change/date/birth/independent | Crear nueva novedad de cambio de fecha de nacimiento independiente |
| POST | /create/novelty/change/working/independent | Crear novedad de cambio de jornada laboral independiente |
| POST | /establish-user-permissions-colmena-management | Establecer permisos de usuario en Colmena Gestión |
| POST | /independent-work-accident | Crear accidente de trabajo independiente |
| POST | /obtain-access-to-hive-management | Obtener acceso a Colmena Gestión |
| POST | /obtain-cards-dependent-identification | Obtener carnés por identificación de dependiente |
| POST | /obtain-cards-independent-identification | Obtener carnés por identificación de independiente |
| POST | /obtain-support-affiliate-independent-massive | Obtener soporte de afiliado independiente masivo |
| POST | /obtain-support-affiliate-independent-massive-internal | Obtener soporte de afiliado independiente masivo interno |
| POST | /power-bi-filters | Filtros de Power BI |
| POST | /register-acceptance-terms-conditions-colmena-management | Registrar aceptación de términos y condiciones de Colmena Gestión |
| PUT | /update-novelty-massive-dependent-filing-pending | Actualizar novedad masiva dependiente pendiente de radicación |
| PUT | /update-novelty-massive-independent-pending | Actualizar novedad masiva independiente pendiente |
| PUT | /update-role-worker-colmena-management | Actualizar rol de trabajador en Colmena Gestión |
| PUT | /update-work-accident-independent | Actualizar accidente de trabajo independiente |
⚠️ 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 APOLO v2.