cs-arl-xapi
API del sistema ARP para gestión integral de trabajadores dependientes. Permite crear, retirar y consultar información de empleados, sedes, ubicaciones geográficas
home
🛡️ cs-arl-xapi
API de experiencia (xapi) para servicios de ARL Colmena - Gestión integral de trabajadores dependientes y servicios empresariales.
🌐 Información Base
- URL Base:
https://cs-arl-xapi-v1-{env}.us-e1.cloudhub.io/api/
- Ambientes:
dev
,qa
,prod
- Autenticación: OAuth 2.0
🚀 Quick Start
1. Obtener Token OAuth2
POST https://authentication-services-colmena-{env}.us-e1.cloudhub.io/token
Headers:
client_id: [CONNECTED_APP_CLIENT_ID]
client_secret: [CONNECTED_APP_CLIENT_SECRET]
grant_type: CLIENT_CREDENTIALS
2. Usar la API
Headers requeridos:
client_id: [APP_CLIENT_ID]
client_secret: [APP_CLIENT_SECRET]
Authorization: Bearer [TOKEN]
invoker: {"application":"Portal","addressIPUser":"192.168.80.13","loginUser":"User","userName":"User Name"}
📍 Endpoints Disponibles
Método | Endpoint | Descripción | Enlace de Exchange |
---|---|---|---|
POST | /create-dependent-worker | Crear trabajador dependiente | Ver detalles |
POST | /retired-dependent-workers-cancelled | Cancelar retiro de trabajador | Ver detalles |
GET | /workers/dependent/data | Consultar datos de trabajador | Ver detalles |
GET | /companies/headquarters/{contractConsecutive} | Consultar sedes de empresa por contrato | Ver detalles |
GET | /cities | Catálogo de ciudades | Ver detalles |
GET | /obtain-departments | Catálogo de departamentos | Ver detalles |
GET | /ips-location | Consultar ubicación de IPS | Ver detalles |
POST | /authorization/medical-authorizations | Crear nueva autorización médica | Ver detalles |
⚠️ Códigos de Respuesta
200
OK - Operación exitosa400
Bad Request - Parámetros inválidos401
Unauthorized - Token inválido/expirado404
Not Found - Recurso no encontrado500
Internal Server Error - Error del servidor
📋 Nota Importante
El campo consecutiveContract
corresponde al número de contrato informado en la carta de instrucciones de afiliación. Consulte con /companies/headquarters
si no dispone de este dato.
📞 Soporte
Coordinación de Servicios de Integración
📧 epalma@fgs.co
📲 Recursos
- Última actualización: Septiembre 2025
- Contacto para consultas: epalma@fgs.co