API Gateway · v1.1.0 de los SDK

Integra Compense en tu propio sistema

Un solo API server-to-server para que tu caja de compensación, cooperativa, fintech o IPS opere afiliados, créditos, subsidios, billetera, cartera, PQRS, salud y su ERP desde sus propios sistemas, con SDK oficiales en cinco lenguajes.

Qué es el API Gateway #

El API Gateway de Compense es la puerta de entrada headless a la plataforma: tu sistema le habla por HTTPS con una llave de API y el gateway autentica, valida, aplica idempotencia y límites, y enruta cada petición al motor de negocio de Compense. Todo cuelga de /v1/gateway/..., todas las escrituras devuelven el mismo sobre y todos los errores siguen RFC 9457.

Tu primera llamada
from compense_gateway import CompenseClient

client = CompenseClient(api_key="cmp_...", environment="sandbox")
print(client.system.health().tenant)

Empieza aquí #

Módulos del gateway #

MóduloQué resuelveGuíaReferencia
AfiliadosCruce y carga de la base de afiliados de la entidad.Guíaaffiliates
CréditosRadicar, decidir y desembolsar solicitudes en el motor de decisión.Guíacredits
Subsidios y cuota monetariaSubsidios de ley y la cuota monetaria de cada período.Guíasubsidies · monetary-allowance
BilleteraSaldo, movimientos, P2P, Bre-B, facturas, recargas, cuentas, tarjetas y FX.Guíawallet
CarteraCuotas, recaudos, abonos, pago total y certificados de los créditos desembolsados.Guíaloans
PQRSPeticiones, quejas, reclamos y sugerencias desde tu CRM o call center.Guíapqrs
SaludAgenda y citas, facturación de salud y vacunación para IPS.Guíahealth
AdministrativoTalento humano, nómina, contabilidad y tesorería.Guíaadmin
WebhooksEndpoints, eventos, entregas y reentregas por API.Guíawebhooks
SandboxRelojes de prueba y simuladores para llaves de sandbox.Guíasandbox
Transacciones y sistemaEstado de transacciones y validación de la llave.Guíatransactions · system

Cómo elegir SDK #

Usa el SDK del lenguaje de tu sistema: los cinco cubren las mismas 115 operaciones con las mismas reglas y pasan las mismas pruebas de paridad contra el contrato. Elige tu lenguaje en cualquier pestaña de código y el sitio lo recordará en todas las páginas. Si tu lenguaje no tiene SDK, la referencia del API trae un curl por operación. Comparativa en SDK oficiales.

¿Operas la plataforma en lugar de integrarla?

Las Guías de uso explican, sin código, cómo usar cada módulo desde el panel y las apps.