cs-apolo-sapi-v2
Conector REST flexible que permite acceso seguro y estandarizado a la base de datos APOLO v2. La API ofrece endpoints para gestión de trabajadores, operaciones en sedes y datos de salud, facilitando la integración con sistemas empresariales
home
🛡️cs-apolo2-sapi
Esta API proporciona acceso seguro a los servicios de base de datos APOLO 2, ofreciendo funcionalidad para:
- Certificación de accidentes y gestión de discapacidad de trabajadores
- Administración de afiliados (trabajadores dependientes e independientes)
- Gestión de contratos de empresas y sedes
- Servicios de generación de certificados y documentación
- Programación de citas y gestión de casos
- Servicios de datos financieros y geográficos
Todos los endpoints están organizados de manera estructurada con seguridad mejorada y rendimiento optimizado.
🌐 Información Base
- Título de la API: cs-apolo2-sapi
- URL Base:
https://cs-apolo2-sapi-v1-{env}.us-e1.cloudhub.io/api/
- Opciones de Entorno: dev, qa
🚀 Primeros Pasos
- Autenticación: Asegúrate de tener el client_id y oauth2 requeridos para acceso seguro.
- URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
- Encabezados: Agrega los siguientes encabezados en tus solicitudes de API:-H "invoker: { "application": "Portal","addressIPUser": "192.168.80.13","loginUser": "User","userName": "User Name" }"
🚀 Cómo Consumir
Puedes acceder y consumir esta API a través de las siguientes plataformas:
📍 Endpoints Disponibles
Método | Endpoint | Descripción | Enlace de Exchange |
---|---|---|---|
POST | /create-independent-worker | Crear trabajador independiente | Ver detalles |
POST | /create/new/change/date/birth/independent | Crear nuevo cambio de fecha de nacimiento independiente | Ver detalles |
POST | /create/novelty/change/working/independent | Crear novedad cambio jornada laboral independiente | Ver detalles |
POST | /create-novelty-change-locality-commune-independent | Crear novedad cambio localidad comuna independiente | Ver detalles |
POST | /create-novelty-change-phone-independent | Crear novedad cambio teléfono independiente | Ver detalles |
POST | /create-novelty-independent-sex-change | Crear novedad cambio de sexo independiente | Ver detalles |
POST | /create-novelty-dependent-sex-change | Crear novedad cambio de sexo dependiente | Ver detalles |
POST | /create-new-modification-start-date-independent-coverage | Crear nueva modificación fecha inicio cobertura independiente | Ver detalles |
POST | /create-new-modification-start-date-dependent-coverage | Crear nueva modificación fecha inicio cobertura dependiente | Ver detalles |
POST | /create-novelty-change-zone-independent | Crear novedad cambio zona independiente | Ver detalles |
GET | /obtain-card-by-headquarters-independent | Obtener tarjeta por sede independiente | Ver detalles |
GET | /obtain-support-affiliation-independent | Obtener soporte afiliación independiente | Ver detalles |
GET | /basic-affiliate-report | Obtener informe básico de afiliado | Ver detalles |
GET | /cards-by-department-and-independent-city | Obtener tarjetas por departamento y ciudad independiente | Ver detalles |
GET | /cards-by-date-new-independent-entry | Obtener tarjetas por fecha nueva entrada independiente | Ver detalles |
GET | /obtain-novelty-future-worker-independent | Obtener novedad trabajador futuro independiente | Ver detalles |
GET | /obtain-novelty-recent-worker-independent | Obtener novedad trabajador reciente independiente | Ver detalles |
POST | /create-new-independent-retirement | Crear nuevo retiro independiente | Ver detalles |
POST | /create-new-dependent-retirement | Crear nuevo retiro dependiente | Ver detalles |
GET | /support-new-worker | Obtener soporte nuevo trabajador | Ver detalles |
GET | /obtain-types-employment-link | Obtener tipos vínculo laboral | Ver detalles |
GET | /obtain-types-employment-link-worker | Obtener tipos vínculo laboral trabajador | Ver detalles |
GET | /obtain-types-habitual-occupation | Obtener tipos ocupación habitual | Ver detalles |
GET | /obtain-types-accidents | Obtener tipos de accidentes | Ver detalles |
GET | /obtain-sites-accident | Obtener sitios de accidente | Ver detalles |
GET | /obtain-types-injury | Obtener tipos de lesión | Ver detalles |
GET | /obtain-body-parts | Obtener partes del cuerpo | Ver detalles |
GET | /obtain-accident-agent | Obtener agente de accidente | Ver detalles |
GET | /obtain-accident-forms | Obtener formularios de accidente | Ver detalles |
GET | /obtain-all-contracts-Worker | Obtener lista de todos los contratos de trabajadores | Ver detalles |
GET | /load-zone-types | Cargar tipos de zona | Ver detalles |
GET | /obtain-contracts-by-independent-worker | Obtener contratos por trabajador independiente | Ver detalles |
POST | /create-new-change-independent-headquarters | Crear nuevo cambio sede independiente | Ver detalles |
POST | /create-new-change-dependent-headquarters | Crear nuevo cambio sede dependiente | Ver detalles |
GET | /files-sent-by-independent-date-ranges | Archivos enviados por rangos de fechas independientes | Ver detalles |
GET | /obtain-types-risk-factors-disease | Obtener tipos factores de riesgo enfermedad | Ver detalles |
GET | /obtain-card-by-city-state-dependent | Obtener tarjeta por ciudad estado dependiente | Ver detalles |
GET | /obtain-card-by-novelty-entry-date-dependent | Obtener tarjeta por fecha entrada novedad dependiente | Ver detalles |
GET | /obtain-card-by-headquarters-dependent | Obtener tarjeta por sede dependiente | Ver detalles |
POST | /bulk-upload-independents | Carga masiva independientes | Ver detalles |
GET | /obtain-retroactive-withdrawals-closing | Obtener retiros retroactivos cierre | Ver detalles |
POST | /create-novelty-cancellation-entry-dependent | Crear novedad cancelación entrada dependiente | Ver detalles |
POST | /create-novelty-change-locality-commune-dependent | Crear novedad cambio localidad comuna dependiente | Ver detalles |
POST | /create-novelty-change-phone-dependent | Crear novedad cambio teléfono dependiente | Ver detalles |
POST | /create-novelty-change-zone-dependent | Crear novedad cambio zona dependiente | Ver detalles |
GET | /obtain-retroActive-withdrawals-theDay-closing | Obtener retiros retroactivos del día cierre | Ver detalles |
GET | /create-new-change-dependent-email | Obtener crear nuevo cambio correo dependiente | Ver detalles |
POST | /create-novelty-change-Eps-dependent | Crear nuevo cambio identificación dependiente | Ver detalles |
GET | /create-new-change-Afp-dependent | Obtener crear nuevo cambio AFP dependiente | Ver detalles |
GET | /create-novelty-change-dependent-cellPhone | Obtener crear novedad cambio teléfono celular dependiente | Ver detalles |
GET | /obtain-files-sent-retroactive-withdrawal-closing | Obtener archivos enviados retiro retroactivo cierre | Ver detalles |
GET | /obtain-novelty-future-worker-dependent | Obtener novedad trabajador futuro dependiente | Ver detalles |
POST | /create-novelty-cancellation-retirement-dependent | Crear novedad cancelación retiro dependiente | Ver detalles |
POST | /create-novelty-change-city-dependent | Crear novedad cambio ciudad dependiente | Ver detalles |
POST | /create-novelty-change-position-dependent | Crear novedad cambio cargo dependiente | Ver detalles |
POST | /health-service/employer/membership-Arl | Membresía empleador ARL | Ver detalles |
POST | /health-service/employer/retractionTransferOrEmployerAffiliationArl | Retracto traslado o afiliación empleador ARL | Ver detalles |
POST | /health-service/employer/beginningEmploymentRelationship | Inicio relación laboral | Ver detalles |
POST | /health-service/employer/terminationEmploymentRelationship | Terminación relación laboral | Ver detalles |
POST | /health-service/headquarters/noveltyNotification | Notificación novedad sede | Ver detalles |
POST | /health-service/workCenter/novelties | Novedades centro de trabajo | Ver detalles |
POST | /health-service/workCenter/variationWorkCenterforDependentWorkersAndStudents | Variación centro trabajo para trabajadores dependientes y estudiantes | Ver detalles |
POST | /health-service/arlEmployerTransfer/origin-ARL | Traslado empleador ARL origen-ARL | Ver detalles |
POST | /health-service/arlEmployerTransfer/destination-ARL/transferNotification | Traslado empleador ARL destino-ARL notificación traslado | Ver detalles |
GET | /create-new-change-date-of-birth-dependent | Obtener crear nuevo cambio fecha nacimiento dependiente | Ver detalles |
GET | /create-new-change-identification-dependent | Obtener crear nuevo cambio identificación dependiente | Ver detalles |
GET | /support-new-extension-end-independent-validity | Obtener soporte nueva extensión fin vigencia independiente | Ver detalles |
GET | /medical-evaluations | Obtener evaluaciones médicas | Ver detalles |
PUT | /update-work-accident-independent | Actualizar accidente trabajo independiente | Ver detalles |
POST | /create-novelty-retroactive-retirement-individual-closing | Crear novedad retiro retroactivo individual cierre | Ver detalles |
POST | /create-novelty-retirement-retroactive-massive-closing | Crear novedad retiro retroactivo masivo cierre | Ver detalles |
POST | /create-novelty-change-journey-dependent | Crear novedad cambio jornada dependiente | Ver detalles |
POST | /create-novelty-change-names-dependent | Crear novedad cambio nombres dependiente | Ver detalles |
POST | /bulk-upload-novelty-dependent | Carga masiva novedad dependiente | Ver detalles |
GET | /obtain-novelty-recent-worker-dependent | Obtener novedad trabajador reciente dependiente | Ver detalles |
GET | /obtain-files-send-by-dates-ranges-dependent | Obtener archivos enviados por rangos fechas dependiente | Ver detalles |
GET | /obtain-contracts-for-retired-independent-worker | Obtener contratos para trabajador independiente retirado | Ver detalles |
GET | /obtain-novelty-bulk-pending-filing-dependent | Obtener novedad masiva pendiente radicación dependiente | Ver detalles |
GET | /obtain-ats-without-filing-dependent | Obtener ATs sin radicación dependiente | Ver detalles |
GET | /obtain-support-affiliate-dependent | Obtener soporte afiliado dependiente | Ver detalles |
GET | /obtain-accidents-filed-company-uptodate-dependent | Obtener accidentes radicados empresa actualizada dependiente | Ver detalles |
POST | /obtain-support-affiliate-independent-massive-internal | Obtener soporte afiliado independiente masivo interno | Ver detalles |
GET | /obtain-diagnoses | Obtener diagnósticos | Ver detalles |
GET | /obtain-diagnosed-by | Obtener diagnosticado por | Ver detalles |
GET | /obtain/registration/control/massive/report/affiliation | Obtener control registro informe masivo afiliación | Ver detalles |
POST | /reprocess-massive-new | Reprocesar nueva masiva | Ver detalles |
POST | /reprocess-massive-news-pending-filing | Reprocesar noticias masivas pendientes radicación | Ver detalles |
POST | /customers/identity-data | Datos identidad cliente | Ver detalles |
POST | /obtain-support-affiliate-independent-massive | Obtener soporte afiliado independiente masivo | Ver detalles |
GET | /independent-workers-coverage | Cobertura trabajadores independientes | Ver detalles |
GET | /worker-salary | Salario trabajador | Ver detalles |
GET | /create-new-change-salary-dependent | Crear nuevo cambio salario dependiente | Ver detalles |
GET | /obtain-contract-type | Obtener tipo contrato | Ver detalles |
GET | /obtain-novelties-bulk-pending-filing-dependent | Obtener novedades masivas pendientes radicación dependiente | Ver detalles |
GET | /obtain-novelties-bulk-successful-filed-dependent | Obtener novedades masivas exitosamente radicadas dependiente | Ver detalles |
GET | /obtain-successful-income-file-independent | Obtener archivo ingreso exitoso independiente | Ver detalles |
GET | /obtain-wrong-income-file-independent | Obtener archivo ingreso erróneo independiente | Ver detalles |
GET | /check-status-process-generation-support-affiliation | Verificar estado proceso generación soporte afiliación | Ver detalles |
GET | /create-new-identification | Crear nueva identificación | Ver detalles |
GET | /work-center-table-support-by-company | Soporte tabla centro trabajo por empresa | Ver detalles |
GET | /types-news-headquarters | Tipos noticias sedes | Ver detalles |
GET | /support-novelty-headquarters-change-telephone | Soporte novedad sede cambio teléfono | Ver detalles |
GET | /support-news-headquarters-change-address | Soporte noticias sede cambio dirección | Ver detalles |
GET | /support-novelty-headquarters-change-fax | Soporte novedad sede cambio fax | Ver detalles |
DELETE | /remove-record-control-massive-affiliation | Remover registro control afiliación masiva | Ver detalles |
PUT | /update-company | Actualizar empresa | Ver detalles |
GET | /obtain-configuration-parameter | Obtener parámetro configuración | Ver detalles |
GET | /validate-user-registration-business-group | Validar registro usuario grupo empresarial | Ver detalles |
GET | /obtain-work-center-approval-report | Obtener informe aprobación centro trabajo | Ver detalles |
GET | /obtain-applications-company-work-centers | Obtener aplicaciones centros trabajo empresa | Ver detalles |
PUT | /update-data-company-resolution-ugpp | Actualizar datos empresa resolución UGPP | Ver detalles |
GET | /obtain-independent-worker-by-consecutive-worker | Obtener trabajador independiente por consecutivo trabajador | Ver detalles |
POST | /disallow-product-by-contract | Desactivar producto por contrato | Ver detalles |
POST | /disallow-product-by-massive-contract | Desactivar producto por contrato masivo | Ver detalles |
GET | /obtain-independent-worker-data | Obtener datos trabajador independiente | Ver detalles |
POST | /obtain-headquarters-with-responsible-apolo | Obtener sedes con responsable apolo | Ver detalles |
POST | /obtain-access-to-hive-management | Obtener acceso a gestión colmena | Ver detalles |
DELETE | /remove-product-by-contract | Eliminar producto por contrato | Ver detalles |
DELETE | /remove-exceptions-from-news-for-the-company | Eliminar excepciones de noticias para la empresa | Ver detalles |
GET | /user-validation-complies-with-business-rules | Validación usuario cumple reglas negocio | Ver detalles |
GET | /contract-exceptions-news | Noticias excepciones contrato | Ver detalles |
GET | /obtain-closing-period-of-operations | Obtener período cierre operaciones | Ver detalles |
GET | /obtain-list-of-unlegalized-accidents | Obtener lista accidentes no legalizados | Ver detalles |
POST | /allow-product-by-contract | Permitir producto por contrato | Ver detalles |
POST | /allow-product-by-massive-contract | Permitir producto por contrato masivo | Ver detalles |
POST | /save-contacts | Guardar contactos | Ver detalles |
GET | /create-new-closing-work-center-with-workers | Crear nuevo cierre centro trabajo con trabajadores | Ver detalles |
GET | /create-retroactive-closing-period | Crear período cierre retroactivo | Ver detalles |
POST | /establish-user-permissions/colmena-gestion | Establecer permisos usuario en Colmena Gestión | Ver detalles |
GET | /obtain-user/colmena-gestion | Obtener usuario colmena gestión | Ver detalles |
GET | /obtain-detail-application-center-work | Obtener detalle aplicación centro-trabajo | Ver detalles |
PUT | /update-novelty-massive-independent-pending | Actualizar novedad masiva independiente pendiente | Ver detalles |
GET | /obtain-company | Obtener empresa | Ver detalles |
POST | /create-request-new-work-center-company | Crear solicitud nuevo centro trabajo empresa | Ver detalles |
PUT | /update-novelty-massive-dependent-filing-pending | Actualizar novedad masiva dependiente radicación pendiente | Ver detalles |
POST | /create-novelty-change-basic-data-center-work | Crear novedad cambio datos básicos centro trabajo | Ver detalles |
POST | /create-novelty-closure-center-work | Crear nuevo cierre centro trabajo | Ver detalles |
GET | /obtain-dependent-workers-By-WorkCenter | Obtener trabajadores dependientes por centro trabajo | Ver detalles |
GET | /obtain-companies-holding-by-identification | Obtener empresas holding por identificación | Ver detalles |
POST | /create-novelty-change-work-center-dependents | Crear novedad cambio centro trabajo dependientes | Ver detalles |
GET | /obtain-paid-returns | Obtener devoluciones pagadas | Ver detalles |
GET | /obtain-indicatives-by-state | Obtener indicativos por estado | Ver detalles |
GET | /obtain-contacts | Obtener contactos | Ver detalles |
POST | /independent-work-accident | Accidente trabajo independiente | Ver detalles |
GET | /obtain-main-headquarter | Obtener sede principal | Ver detalles |
POST | /obtain-cards-dependent-identification | Obtener tarjetas identificación dependiente | Ver detalles |
GET | /obtain-optional-report-fields | Obtener campos opcionales informe | Ver detalles |
GET | /obtain-products | Obtener productos | Ver detalles |
GET | /obtain-regional | Obtener regional | Ver detalles |
GET | /obtain-specific-business-types | Obtener tipos negocio específicos | Ver detalles |
GET | /obtain-branches-by-regional | Obtener sucursales por regional | Ver detalles |
GET | /obtain-company-niches | Obtener nichos empresa | Ver detalles |
GET | /obtain-niches | Obtener nichos | Ver detalles |
GET | /obtain-contract-states | Obtener estados contrato | Ver detalles |
GET | /obtain-economic-activities-by-niche | Obtener actividades económicas por nicho | Ver detalles |
PUT | /update-company-exceptions | Actualizar excepciones empresa | Ver detalles |
PUT | /update-job-center-creation-request-status | Actualizar estado solicitud creación centro trabajo | Ver detalles |
GET | /obtain-company-by-contract-number | Obtener empresa por número contrato | Ver detalles |
GET | /obtain-products-by-company | Obtener productos por empresa | Ver detalles |
GET | /obtain-company-not-linked-by-id | Obtener empresa no vinculada por ID | Ver detalles |
POST | /obtain-companies-by-filters-for-authorization | Obtener empresas por filtros para autorización | Ver detalles |
GET | /obtain-job-center-creation-request | Obtener solicitud creación centro trabajo | Ver detalles |
POST | /register-acceptance-terms-conditions-colmena-management | Registrar aceptación términos condiciones gestión colmena | Ver detalles |
GET | /obtain-dependent-linker-types | Obtener tipos vinculador dependiente | Ver detalles |
PUT | /update-role-worker-colmena-management | Actualizar rol trabajador gestión colmena | Ver detalles |
PUT | /update-closing-period-retro-active | Actualizar período cierre retroactivo | Ver detalles |
POST | /establish-user-permissions-colmena-management | Establecer permisos usuario en gestión colmena | Ver detalles |
GET | /obtain-embedded-information | Obtener información embebida | Ver detalles |
POST | /power-bi-filters | Filtros POWER BI | Ver detalles |
GET | /obtain-audit-report-colmena-gestion | Obtener informe auditoría Colmena Gestión | Ver detalles |
POST | /check-bulk-upload-status | Verificar estado carga masiva | Ver detalles |
POST | /bulk-upload-novelty-dependent-background | Carga masiva nueva dependiente en segundo plano | Ver detalles |
POST | /bulk-upload-novelty-independent-background | Carga masiva nueva independiente en segundo plano | Ver detalles |
GET | /obtain-attachments-by-type-process | Obtener adjuntos por tipo proceso | Ver detalles |
GET | /obtain-accident-reports-independent-company-up-to-date | Obtener informes accidentes empresa independiente actualizada | Ver detalles |
GET | /get-filed-accidents-dependent-worker | Obtener accidentes radicados trabajador dependiente | Ver detalles |
GET | /get-filed-accidents-independent-worker | Obtener accidentes radicados trabajador independiente | Ver detalles |
GET | /obtain-report-rosette | Obtener informe roseta | Ver detalles |
GET | /obtain-events-by-person | Obtener eventos por persona | Ver detalles |
GET | /obtain-certified-report | Obtener informe certificado | Ver detalles |
GET | /obtain-products-by-contract | Obtener productos por contrato | Ver detalles |
POST | /obtain-cards-independent-identification | Obtener tarjetas identificación independiente | Ver detalles |
GET | /obtain-novelty-bulk-pending-filing-independent | Obtener novedad masiva pendiente radicación independiente | Ver detalles |
GET | /contract-states | Estados contrato | Ver detalles |
GET | /obtain-card-report-records | Obtener registros informe tarjeta | Ver detalles |
POST | /generation-certificate-payment-of-disabilities | Generación certificado pago de discapacidades | Ver detalles |
GET | /get-disability-payments | Generación pagos de discapacidad | Ver detalles |
GET | /consult-card-cover | Consultar carátula tarjeta | Ver detalles |
GET | /v1/get-company-workers | Obtener información de trabajadores | Ver detalles |
GET | /v1/get-company-worker-centers | Obtener información centros trabajo empresa | Ver detalles |
PUT | /inovice-reserve-headers | Encabezados reserva factura | Ver detalles |
PUT | /invoice-reserve-details | Detalles reserva factura | Ver detalles |
DELETE | /remove-user-colmena-management | Remueve permisos usuario en Colmena gestión | Ver detalles |
📤 Ejemplo de Solicitud (Genérica)
curl -X GET "https://cs-apolo2-sapi-v1-dev.us-e1.cloudhub.io/api/[endpoint-ejemplo]" \
-H "client_id: TU_CLIENT_ID" \
-H "invoker: { \"application\": \"Portal\",\"addressIPUser\": \"192.168.80.13\",\"loginUser\": \"User\",\"userName\": \"User Name\" }"
⚠️ Manejo de Errores
Se utilizan códigos de estado HTTP estándar para el manejo de errores:
200 OK
– La solicitud fue exitosa400 Bad Request
– Parámetros faltantes o inválidos401 Unauthorized
– Falló la autenticación404 Not Found
– Endpoint o recurso no encontrado500 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: Julio 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