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.
from compense_gateway import CompenseClient
client = CompenseClient(api_key="cmp_...", environment="sandbox")
print(client.system.health().tenant)import { CompenseClient } from "@compense/sdk";
const client = new CompenseClient({ apiKey: "cmp_...", environment: "sandbox" });
console.log((await client.system.health()).tenant);use Compense\Sdk\CompenseClient;
$client = new CompenseClient(apiKey: 'cmp_...', environment: 'sandbox');
echo $client->system->health()->tenant;using var client = new CompenseClient("cmp_...", CompenseEnvironment.Sandbox);
Console.WriteLine((await client.System.HealthAsync()).Tenant);client, _ := compense.NewClient("cmp_...", compense.WithEnvironment(compense.Sandbox))
health, _ := client.System.Health(context.Background())
fmt.Println(health.Tenant)curl https://sandbox.dev.compense.co/gw/v1/gateway/health/ -H "X-API-Key: cmp_..."Empieza aquí #
Módulos del gateway #
| Módulo | Qué resuelve | Guía | Referencia |
|---|---|---|---|
| Afiliados | Cruce y carga de la base de afiliados de la entidad. | Guía | affiliates |
| Créditos | Radicar, decidir y desembolsar solicitudes en el motor de decisión. | Guía | credits |
| Subsidios y cuota monetaria | Subsidios de ley y la cuota monetaria de cada período. | Guía | subsidies · monetary-allowance |
| Billetera | Saldo, movimientos, P2P, Bre-B, facturas, recargas, cuentas, tarjetas y FX. | Guía | wallet |
| Cartera | Cuotas, recaudos, abonos, pago total y certificados de los créditos desembolsados. | Guía | loans |
| PQRS | Peticiones, quejas, reclamos y sugerencias desde tu CRM o call center. | Guía | pqrs |
| Salud | Agenda y citas, facturación de salud y vacunación para IPS. | Guía | health |
| Administrativo | Talento humano, nómina, contabilidad y tesorería. | Guía | admin |
| Webhooks | Endpoints, eventos, entregas y reentregas por API. | Guía | webhooks |
| Sandbox | Relojes de prueba y simuladores para llaves de sandbox. | Guía | sandbox |
| Transacciones y sistema | Estado de transacciones y validación de la llave. | Guía | transactions · 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.