Riesgos Laborales
home
🛡️ cs-arl-xapi
La API cs-arl-xapi provee una solución integral para la gestión de información de trabajadores dependientes, afiliaciones y autorizaciones médicas en el sistema ARL, permitiendo la integración controlada con servicios corporativos internos.
Expone operaciones REST para:
- Registro y retiro de trabajadores dependientes en el sistema ARL
- Consulta de trabajadores y dependientes asociados a contratos
- Creación de autorizaciones médicas
- Consulta de información geográfica (departamentos, ciudades e IPS)
- Integración con servicios corporativos como APOLO SAPI y SENDA SAPI
La API actúa como una Experience API (XAPI), gestionada desde MuleSoft Anypoint Platform.
🌐 Información Básica
- Nombre de la API: cs-arl-xapi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- Runtime: Mule 4.4.0
- Tipo: Experience API
- URL Base QA:
https://cs-arl-xapi-qa-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:
Client ID Enforcement
Headers requeridos:
client_idclient_secret
- Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
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:
- 🔗 MuleSoft Exchange – cs-arl-xapi https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/2b26d155-74f8-4cf2-aaea-ec3c05e8433a/cs-arl-xapi/
- 🔗 Portal Público FGS https://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
📋 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étodo | Endpoint | Descripción |
|---|---|---|
| POST | /create-dependent-worker | Crear un trabajador dependiente en el sistema ARL |
| POST | /retired-dependent-workers-cancelled | Registrar el retiro de trabajadores dependientes |
| GET | /workers/dependent/data | Consultar trabajadores dependientes asociados a un contrato |
| GET | /companies/headquarters/{contractConsecutive} | Consultar sedes empresariales asociadas a un contrato |
| GET | /cities | Listar ciudades, opcionalmente filtradas por departamento |
| GET | /obtain-departments | Obtener la lista de departamentos |
| GET | /ips-location | Consultar IPS según criterios de búsqueda |
| POST | /authorization/medical-authorizations | Crear una autorización médica |
⚠️ 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 Enero 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 ARL.