cs-compliance-sapi
🛡️ cs-compliance-sapi
La API cs-compliance-sapi provee una solución integral para la gestión de cumplimiento normativo en riesgos laborales y notificaciones regulatorias a la ARL (Administradora de Riesgos Laborales), operando como una capa de sistema para el procesamiento de información del sistema SIIFA (Sistema de Información de Inspección, Fiscalización y Aduanas).
Expone operaciones REST para:
- Gestión de contratos (agreements) en SIIFA
- Administración de empresas y datos corporativos
- Procesamiento masivo de radicados de facturas
- Consulta y gestión de facturas electrónicas
- Administración de alertas de facturación
- Consulta de códigos de referencia y dominios
- Validación de información de emisores y compradores
La API actúa como una System API (SAPI), gestionada desde MuleSoft Anypoint Platform.
🌐 Información Básica
- Nombre de la API: cs-compliance-sapi
- Versión: 1.0.0
- Plataforma: MuleSoft Anypoint Platform
- Runtime: Mule 4.x
- Tipo: System API
- URL Base QA:
https://cs-compliance-sapi-qa-v1.us-e1.cloudhub.io/api/ - URL Base PROD:
https://cs-compliance-sapi-prod-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 el siguiente mecanismo de seguridad:
Client ID Enforcement
Headers requeridos:
client_idclient_secret
- Las credenciales son asignadas a la aplicación consumidora en MuleSoft Anypoint Platform.
🔒 Aviso de Seguridad
Las credenciales (client_id,client_secret) 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-compliance-sapihttps://anypoint.mulesoft.com/exchange/portals/fundacion-grupo-social/
- 🔗 Portal Público FGShttps://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
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /siifa/v1/agreements | Consultar lista paginada de contratos con filtros opcionales |
| POST | /siifa/v1/agreements | Crear un nuevo contrato en SIIFA |
| PUT | /siifa/v1/agreements | Actualizar información de un contrato existente |
| GET | /siifa/v1/agreements/{agreementId} | Obtener información detallada de un contrato específico |
| DELETE | /siifa/v1/agreements/{agreementId} | Eliminar un contrato por su identificador único |
| GET | /siifa/v1/companies/{nit} | Obtener información de empresa por NIT |
| GET | /siifa/v1/invoice-filings | Consultar radicados de facturas por ID de factura |
| POST | /siifa/v1/invoice-filings | Radicar una factura individual en SIIFA |
| POST | /siifa/v1/invoice-filings/bulk | Radicar múltiples facturas de forma masiva |
| GET | /siifa/v1/invoice-filings/{invoiceFiledId} | Obtener información detallada de un radicado específico |
| GET | /siifa/v1/invoices | Consultar lista paginada de facturas con filtros avanzados |
| GET | /siifa/v1/invoices/{invoiceId} | Obtener información completa de una factura específica |
| GET | /siifa/v1/invoices/{invoiceId}/alerts | Consultar alertas asociadas a una factura |
| GET | /compliance/v1/siifa/agreements | Consultar una lista paginada de contratos registrados en el sistema SIIFA |
| POST | /compliance/v1/siifa/agreements | Permite registrar un nuevo contrato en el sistema SIIFA |
| PUT | /compliance/v1/siifa/agreements | Permite actualizar la información de un contrato existente en el sistema SIIFA |
| DELETE | /compliance/v1/siifa/agreements/{agreementId} | Permite eliminar permanentemente un contrato del sistema SIIFA |
| GET | /compliance/v1/siifa/agreements/{agreementId} | Permite consultar la información completa de un contrato registrado en el sistema SIIFA |
| GET | /siifa/v1/reference-codes | Obtener todos los códigos de referencia disponibles |
| GET | /siifa/v1/reference-codes/{domainId} | Consultar códigos de referencia por dominio específico |
| GET | /compliance/v1/siifa/companies/{nit} | Permite consultar la información detallada de una empresa registrada en el sistema SIIFA |
⚠️ 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 |
📋 Características Principales
Gestión de Contratos SIIFA
- Creación, consulta, actualización y eliminación de contratos
- Filtrado avanzado por NIT contratante/contratista, estado, año de suscripción
- Paginación configurable para consultas masivas
- Soporte para regímenes de salud y modalidades de pago
Radicación de Facturas
- Radicación individual y masiva de facturas electrónicas
- Validación automática de existencia de facturas
- Generación de números de radicado únicos
- Consulta de historial de radicados por factura
Consulta de Facturas
- Búsqueda avanzada con múltiples criterios (NIT emisor/comprador, fechas, número de factura)
- Alertas y notificaciones asociadas a facturas
- Paginación optimizada para grandes volúmenes
- Filtrado por estado de radicación
Gestión de Empresas
- Consulta de información corporativa por NIT
- Validación de datos de emisores y compradores
- Información de razón social y datos de contacto
📞 Soporte
Para soporte técnico o incidencias relacionadas con la integración:
Coordinación de Servicios de Integración y Aplicaciones
Correo electrónico: epalma@fgs.co
📅 Información Adicional
Documentación actualizada en Julio 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 el cumplimiento normativo y regulatorio de la ARL.