cs-apolo-sapi icon

cs-apolo-sapi

1.0.x
(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.

🏠 Inicio - 🛡️cs-apolo-sapi

Esta API ofrece servicios integrales para la gestión de datos de la base de datos APOLO. Incluye endpoints para:

  • Consultas de certificación de accidentes y tasas
  • Gestión de afiliaciones y contratos
  • Administración de trabajadores dependientes e independientes
  • Gestión de sedes y centros de trabajo
  • Certificaciones de afiliación y cartas de trabajadores
  • Beneficios económicos e informes
  • Programación de citas y gestión de novedades
  • Consultas de información financiera y geográfica
  • Informes de enfermedades laborales y accidentes de trabajo

Todos los servicios están expuestos a través de una estructura organizada y proporcionan acceso seguro a las validaciones del backend.

🌐 Información Base

  • Título de la API: cs-apolo-sapi
  • Versión: 1.0.0
  • URL Base: https://cs-apolo-sapi-{env}-v1.us-e1.cloudhub.io/api/
  • Opciones de Entorno: dev, qa

🚀 Primeros Pasos

  1. Autenticación: Asegúrate de tener el client_id y oauth2 requeridos para acceso seguro.
  2. URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
  3. 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étodoEndpointDescripciónEnlace de Exchange
GET/accident/rate/certificationObtener certificación de tasa de accidentesVer detalles
POST/accident/rate/certification/annualCertificación anual de tasa de accidentesVer detalles
GET/accident/rate/certification/workerObtener certificación de tasa de accidentes del trabajadorVer detalles
POST/accident/rate/certification/disability/workerObtener certificación de discapacidad por tasa de accidentes del trabajadorVer detalles
POST/accidentsObtener lista de accidentesVer detalles
GET/accidents/headquartersObtener sedes de accidentesVer detalles
POST/affiliate/certification/letter/dependentObtener carta de certificación de afiliado dependienteVer detalles
POST/affiliate/certification/letter/independentObtener carta de certificación de afiliado independienteVer detalles
POST/affiliate/certification/annex/dependentObtener anexo de certificación de afiliado dependienteVer detalles
POST/affiliate-certification-annex-independentAnexo de certificación de afiliado independienteVer detalles
POST/affiliations-contractsCrear contrato de afiliaciónVer detalles
GET/affiliate/ARPObtener afiliado ARPVer detalles
GET/at/employer/contracting/reportObtener informe de contratación de empleador ATVer detalles
DELETE/appointment-schedulingCancelar programación de citaVer detalles
POST/appointment-schedulingCrear programación de citaVer detalles
GET/citiesObtener lista de ciudadesVer detalles
GET/cities/contract/{idContract}Obtener ciudades por ID de contratoVer detalles
GET/companies/{id}Obtener empresas por númeroVer detalles
GET/companies/policiesObtener todas las pólizasVer detalles
GET/companies/contracts/{id}Obtener todos los contratos por IDVer detalles
POST/companies/contracts/{id}/member-by-day-of-birthObtener miembro por día de nacimientoVer detalles
GET/companies/workersObtener todos los trabajadoresVer detalles
POST/companies/workers/contact-informationCrear nueva información de contactoVer detalles
PUT/companies/workers/contact-informationActualizar información de contactoVer detalles
GET/companies/headquarters/{contractConsecutive}Obtener sedes de empresaVer detalles
POST/companies/headquarters/certification/currentObtener certificación actual de sedesVer detalles
GET/contactsObtener todos los contactosVer detalles
POST/create-dependent-workerCrear trabajador dependienteVer detalles
GET/customersObtener todos los clientesVer detalles
GET/independent-workers/{id}Obtener datos de trabajador independienteVer detalles
GET/dependent-workers/{id}Obtener datos de trabajador dependienteVer detalles
GET/dependent-workers-filter/{id}Obtener datos de trabajador dependiente con filtro de mostrarVer detalles
GET/economic/benefit/reportInforme de beneficio económicoVer detalles
GET/providersObtener todos los proveedoresVer detalles
GET/v2/companies/contracts/{id}Obtener todos los contratos por IDVer detalles
GET/participantsObtener participantesVer detalles
GET/indemnitiesObtener indemnizacionesVer detalles
GET/policiesObtener todas las pólizasVer detalles
POST/pymes-affiliationsCrear/Notificar nueva afiliación PYMEVer detalles
GET/pymes-affiliations/{affiliation_id}Obtener afiliaciones PYMES por IDVer detalles
POST/pymes-affiliations/{affiliation_id}/returnsPOST devoluciones de afiliaciones PYMESVer detalles
POST/v2/pymes-affiliations/{affiliation_id}/returnsPOST devoluciones de afiliaciones PYMESVer detalles
GET/info-financial-workerObtener información financiera del trabajadorVer detalles
PUT/info-financial-workerActualizar información financiera del trabajadorVer detalles
GET/special-agreementObtener información de acuerdo especialVer detalles
GET/subsidiary-arp/{id}Obtener subsidiaria ARPVer detalles
GET/departments/contract/{idContract}Obtener departamentos por ID de contratoVer detalles
POST/dependent-worker/massiveCrear trabajador dependiente para formulario de contingencia Jotform-masivoVer detalles
POST/dependent-workerCrear trabajador dependiente para formulario de contingencia JotformVer detalles
GET/news/deltas/headquartersObtener tipos de cambios de novedades de sedesVer detalles
GET/news/portalObtener tipos de novedades del portalVer detalles
GET/type-identificactionObtener tipo de identificaciónVer detalles
GET/contracts/work-centers/{contractConsecutive}Obtener centros de trabajo del contratoVer detalles
POST/pcc/file-worker-contactPOST archivo de contacto de trabajador PCCVer detalles
GET/headquarters/relationshipObtener informe de relación de sedesVer detalles
GET/news/companiesObtener tipos de novedades del portalVer detalles
GET/news/headquartersObtener tipos de novedades del portalVer detalles
GET/news/types/workers/independent/filterObtener tipos de novedades del portalVer detalles
POST/independent-workerCrear trabajador independiente para formulario de contingencia JotformVer detalles
POST/independent-worker/massiveCrear trabajador independiente para formulario de contingencia Jotform-masivoVer detalles
GET/news/earns-income/independentObtener tipos de novedades del portalVer detalles
GET/news/earns-income/dependentObtener tipos de novedades del portalVer detalles
GET/quotes/typeObtener tipo de identificaciónVer detalles
GET/other/news/dependentObtener tipos de novedades del portalVer detalles
GET/other/news/independentObtener tipos de novedades del portalVer detalles
POST/current/dependent-workerTrabajador dependiente actual-PortalClientesVer detalles
POST/current/independent-workerTrabajador independiente actual-PortalClientesVer detalles
GET/service-liferay/affiliate/contracts/{idTypeIdentification}/{documentNumber}Obtener contratos por afiliado con nacimientoVer detalles
GET/service-liferay/affiliate/contracts/card/dependent/{idTypeIdentification}/{documentNumber}Obtener tarjeta por identificación de trabajador dependienteVer detalles
GET/service-liferay/affiliate/contracts/card/independent/{idTypeIdentification}/{documentNumber}Obtener tarjeta por identificación de trabajador independienteVer detalles
GET/service-liferay/affiliate/contracts/card/certificate/{idTypeIdentification}/{documentNumber}Obtener certificadoVer detalles
GET/service-liferay/parametric/platformObtener plataformaVer detalles
GET/service-liferay/parametric/economic-sectorObtener plataforma por sector económicoVer detalles
GET/service-liferay/admin-courses/courses/courseObtener cursosVer detalles
GET/service-liferay/admin-courses/courses/platformObtener plataforma de cursosVer detalles
GET/service-liferay/admin-courses/courses/courses-economic-sectorObtener cursos por sector económicoVer detalles
GET/service-liferay/admin-courses/courses/courses-detailObtener detalle de cursosVer detalles
POST/service-liferay/enrollment/enroll-worker-in-courseInscribir trabajador en cursoVer detalles
GET/service-liferay/enrollment/general-enrollment-information/{idTypeIdentification}/{documentNumber}Obtener información general de inscripciónVer detalles
GET/history/news/dependentObtener historial dependiente simuladoVer detalles
GET/history/news/independentObtener historial independiente simuladoVer detalles
GET/companyObtener empresa por número de identificaciónVer detalles
GET/affiliate/certification/abroad/dependentObtener certificado de asistencia en el extranjeroVer detalles
POST/affiliate/certification/special/dependentObtener certificación especial de afiliación de trabajador dependienteVer detalles
POST/affiliate/certification/special/independentObtener certificación especial de afiliación de trabajador independienteVer detalles
GET/current-legal-minimum-wageObtener salario mínimo legal vigenteVer detalles
GET/paid/returnsObtener devoluciones pagadasVer detalles
GET/get-support-newsObtener novedades de soporteVer detalles
GET/load-types-modalityCargar tipos de modalidadVer detalles
POST/obtain-dependent-workers-membershipObtener membresía de trabajadores dependientesVer detalles
GET/certificate-payment-return-contributionsObtener certificado de pago de devolución de aportesVer detalles
POST/collection-report-worker-o-massObtener informe de recaudo de trabajador o masivoVer detalles
GET/obtain-Work-Centers-Number-Of-WorkersObtener número de trabajadores de centros de trabajoVer detalles
GET/obtain-company-work-centersObtener centros de trabajo de empresaVer detalles
GET/obtain-departmentsObtener departamentosVer detalles
GET/workdayObtener jornada laboralVer detalles
GET/obtain-AFP-TypesObtener tipos de AFPVer detalles
GET/obtain-ARP-TypesObtener tipos de ARPVer detalles
GET/obtain-EPS-TypesObtener tipos de EPSVer detalles
GET/obtain-Gender-TypesObtener tipos de géneroVer detalles
GET/obtain-zone-TypesObtener tipos de zonaVer detalles
GET/obtain-all-citiesObtener todas las ciudadesVer detalles
GET/obtain/certification/company/membershipObtener certificado de membresía de empresaVer detalles
GET/obtain/casesObtener casosVer detalles
GET/obtain-case-ep-client-portalObtener caso EP portal clienteVer detalles
GET/obtain-case-at-client-portalObtener caso AT portal clienteVer detalles
POST/obtain-events-per-workerObtener eventos por trabajadorVer detalles
GET/quoteTypesByWorkerTypeObtener tipos de cotización por tipo de trabajadorVer detalles
GET/subtypes/contributor-type-workerObtener subtipos de tipo cotizante trabajadorVer detalles
GET/verify-disability-proofMétodo responsable de validar si existe un comprobante para un contrato consecutivoVer detalles
POST/workers/dependen/affiliationCrear afiliación de trabajadores dependientesVer detalles
POST/workers/dependent/certification/affiliationObtener certificación de afiliación de trabajador dependienteVer detalles
GET/workers/dependent/coverageCrear cobertura de afiliaciónVer detalles
GET/workers/dependent/dataObtener datos de trabajador dependienteVer detalles
POST/workers/dependent/affiliationCrear afiliación de trabajador dependienteVer detalles
POST/workers/dependent/affiliation/certificatedObtener certificación de afiliación dependienteVer detalles
POST/workers/independent/affiliationCrear afiliación de trabajador independienteVer detalles
POST/workers/independent/certification/affiliationObtener certificación de afiliación independienteVer detalles
GET/workers/independent/coverageObtener cobertura de trabajador independienteVer detalles
POST/retired-independent-workers-cancelledTrabajadores independientes retirados canceladosVer detalles
POST/retired-dependent-workers-cancelledTrabajadores dependientes retirados canceladosVer detalles
GET/types/affiliatesObtener tipos de afiliadosVer detalles
GET/contributor-types-worker-typeObtener tipos de cotizante por tipo de trabajadorVer detalles
GET/obtain-Contracts-Per-AffiliateObtener contratos por afiliadoVer detalles
GET/contract-typesObtener tipos de contratoVer detalles
GET/obtain-economic-activitiesObtener actividades económicasVer detalles
GET/obtain-day-typeObtener tipo de díaVer detalles
GET/report-disease-labor-no-qualifiedReporte de enfermedad laboral no calificadaVer detalles
GET/workplaceObtener lugar de trabajoVer detalles
GET/obtain-disability-states-report-economic-benefitsObtener estados de discapacidad reporte beneficios económicosVer detalles
POST/cancellation-independent-withdrawalCancelación retiro independienteVer detalles
GET/obtain/accident/reportObtener reporte de accidenteVer detalles
GET/create-novelty-change-independent-cellPhoneCrear novedad cambio teléfono celular independienteVer detalles
GET/create-new-change-independent-emailCrear novedad cambio email independienteVer detalles
POST/extension/validity/independentExtensión validez independienteVer detalles
GET/create-new-independent-IBC-changeCrear novedad cambio IBC independienteVer detalles
GET/obtain-list-affiliation-independentObtener lista afiliación independienteVer detalles
POST/independent-name-changeCambio de nombre independienteVer detalles
GET/obtain-accidents-by-location-reportObtener reporte de accidentes por ubicaciónVer detalles
GET/obtain-occupational-disease-filingsObtener radicados de enfermedad ocupacionalVer detalles
POST/create-novelty-cancellation-entry-independentCrear novedad cancelación entrada independienteVer detalles
POST/create-novelty-change-city-independentCrear novedad cambio ciudad independienteVer detalles
POST/create/new/change/date/birth/independentCrear novedad cambio fecha nacimiento independienteVer detalles
POST/dependent-work-accidentAccidente trabajo dependienteVer detalles
POST/create-independent-workerCrear trabajador independienteVer detalles
GET/headquartersObtener sedesVer detalles
POST/create-new-change-independent-identificationCrear novedad cambio identificación independienteVer detalles
POST/create-novelty-change-Eps-independentCrear novedad cambio EPS independienteVer detalles
GET/create-new-change-Afp-independentCrear novedad cambio AFP independienteVer detalles
POST/generation-certificate-payment-of-disabilitiesGeneración certificado pago de incapacidadesVer detalles
POST/obtain-company-causal-statusObtener estado causal empresaVer detalles
GET/companies/contractsObtener contratos de empresasVer detalles
POST/companies/contracts/member-by-day-of-birthObtener miembro por día de nacimientoVer detalles
GET/v2/companies/contractsObtener contratos de empresas v2Ver detalles
GET/service-liferay/affiliate/contractsObtener contratos de afiliadoVer detalles
GET/service-liferay/affiliate/card/dependentObtener tarjeta afiliado dependienteVer detalles
GET/service-liferay/affiliate/card/independentObtener tarjeta afiliado independienteVer detalles
GET/service-liferay/affiliate/card/certificateObtener certificado tarjeta afiliadoVer detalles
GET/service-liferay/enrollment/general-enrollment-informationObtener información general de inscripciónVer detalles
GET/workers/dependentObtener trabajadores dependientesVer detalles
POST/workers/dependent/affiliation/certificatedCertificación afiliación trabajador dependienteVer detalles
GET/service-liferay/admin-courses/coursesObtener cursos administradorVer detalles

📤 Ejemplo de Solicitud (Genérica)

curl -X GET "https://cs-apolo-sapi-{env}-v1.us-e1.cloudhub.io/api/accidents" \
-H "client_id: TU_CLIENT_ID" \
-H "invoker: { \"application\": \"Portal\",\"addressIPUser\": \"192.168.80.13\",\"loginUser\": \"User\",\"userName\": \"User Name\" }"

Reemplaza los parámetros según el método específico.

⚠️ 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 publicada en julio 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la cs-apolo-sapi

Reviews