API Gateway · SDKs v1.1.0
Integrate Compense into your own systems
One server-to-server API that lets your family compensation fund (caja de compensación), cooperative, fintech or healthcare provider (IPS) run affiliates, credits, subsidies, wallet, loans, PQRS, health and its ERP from its own systems, with official SDKs in five languages.
What the API Gateway is #
The Compense API Gateway is the headless entry point to the platform: your system talks to it
over HTTPS with an API key, and the gateway authenticates, validates, applies idempotency and limits,
and routes each request to the Compense business engine. Everything lives under /v1/gateway/..., every
write returns the same envelope, and every error follows 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_..."Start here #
Gateway modules #
| Module | What it solves | Guide | Reference |
|---|---|---|---|
| Affiliates | Matching and loading the entity’s affiliate base. | Guide | affiliates |
| Credits | Submit, decide and disburse applications in the decision engine. | Guide | credits |
| Subsidies and monetary allowance | Statutory subsidies and each period’s monetary allowance. | Guide | subsidies · monetary-allowance |
| Wallet | Balance, movements, P2P, Bre-B, bills, top-ups, accounts, cards and FX. | Guide | wallet |
| Loans | Installments, collections, partial payments, payoff and certificates for disbursed credits. | Guide | loans |
| PQRS | Petitions, complaints, claims and suggestions from your CRM or call center. | Guide | pqrs |
| Health | Scheduling and appointments, healthcare billing and vaccination for healthcare providers (IPS). | Guide | health |
| Administrative | Human resources, payroll, accounting and treasury. | Guide | admin |
| Webhooks | Endpoints, events, deliveries and redeliveries via the API. | Guide | webhooks |
| Sandbox | Test clocks and simulators for sandbox keys. | Guide | sandbox |
| Transactions and system | Transaction status and key validation. | Guide | transactions · system |
How to choose an SDK #
Use the SDK for your system’s language: all five cover the same 115 operations with the same
rules and pass the same parity tests against the contract. Pick your language in any code tab and
the site will remember it on every page. If your language has no SDK, the
API reference includes a curl for each operation. See the comparison in Official SDKs.
Operating the platform rather than integrating it?
The User guides explain, without code, how to use each module from the dashboard and the apps.