Start here

Getting started

From zero to your first call in the sandbox: the API key, the SDK for your language, the environments and a minimal integration that already handles idempotency and errors.

This section is for the development teams at a family compensation fund (caja de compensación), a cooperative, a fintech or a healthcare provider (IPS) that are going to integrate their systems with Compense via the API. In a few minutes you’ll have a call working against the sandbox, with no real money or data.

Operating the platform rather than integrating it?

You don’t need an API key. Go to the User guides, written for advisors, operators and affiliates.

The recommended path #

  1. Get your API key: what a cmp_... key is, which scopes to request and how to store it.
  2. Install the SDK for your language: Python, JavaScript/TypeScript, PHP, .NET or Go (or use plain HTTP).
  3. Make your first call: validate the key, look up a test affiliate and submit a credit application in the sandbox.
  4. Understand the environments: production, sandbox and dev, and why behavior is determined by the key, not the URL.

Next, read the concepts every integrator needs to master (idempotency, retries, errors, pagination and amounts) and follow the module guide you’re going to integrate.

flowchart LR
  A[Sandbox key<br/>cmp_...] --> B[Install the SDK]
  B --> C[client.system.health<br/>validates key and scopes]
  C --> D[First write<br/>with Idempotency-Key]
  D --> E[Webhooks<br/>on your receiver]
  E --> F[Sandbox testing<br/>clocks and simulators]
  F --> G[Production key<br/>during onboarding]

In this section #

Getting started Get your API keyWhat a cmp_… key is, how to request one, which scopes each module needs, and how to store and rotate it without interrupting service. Getting started Install the SDKInstall the official Compense SDK for Python, JavaScript/TypeScript, PHP, .NET or Go, check its requirements and configure the client: environment, timeout, retries and a … Getting started · 5 minutes First call (quickstart)In five steps: set up the key, create the client, validate the key and its scopes, look up an affiliate and submit a credit application in the sandbox with its … Getting started Environments and keysProduction, sandbox and dev: their base URLs, how to select them in each SDK, and why behavior (simulated or real) is determined by the key, not the URL.