Empieza aquí

Primeros pasos

De cero a tu primera llamada en el sandbox: la llave de API, el SDK de tu lenguaje, los entornos y una integración mínima que ya maneja idempotencia y errores.

Esta sección es para los equipos de desarrollo de una caja de compensación, una cooperativa, una fintech o una IPS que van a integrar sus sistemas con Compense por API. En unos minutos tendrás una llamada funcionando contra el sandbox, sin dinero ni datos reales.

¿Vas a operar la plataforma y no a integrarla?

No necesitas llave de API. Ve a las Guías de uso, escritas para asesores, operadores y afiliados.

La ruta recomendada #

  1. Obtén tu llave de API: qué es una llave cmp_..., qué scopes pedir y cómo guardarla.
  2. Instala el SDK de tu lenguaje: Python, JavaScript/TypeScript, PHP, .NET o Go (o usa HTTP directo).
  3. Haz tu primera llamada: valida la llave, consulta un afiliado de prueba y radica un crédito en el sandbox.
  4. Entiende los entornos: producción, sandbox y dev, y por qué el comportamiento lo decide la llave y no la URL.

Después, lee los conceptos que todo integrador debe dominar (idempotencia, reintentos, errores, paginación y montos) y sigue la guía del módulo que vas a integrar.

flowchart LR
  A[Llave de sandbox<br/>cmp_...] --> B[Instalar el SDK]
  B --> C[client.system.health<br/>valida llave y scopes]
  C --> D[Primera escritura<br/>con Idempotency-Key]
  D --> E[Webhooks<br/>en tu receptor]
  E --> F[Pruebas en sandbox<br/>relojes y simuladores]
  F --> G[Llave de producción<br/>en el onboarding]

En esta sección #

Primeros pasos Obtén tu llave de APIQué es una llave cmp_…, cómo se pide, qué scopes necesita cada módulo y cómo guardarla y rotarla sin cortar el servicio. Primeros pasos Instala el SDKInstala el SDK oficial de Compense en Python, JavaScript/TypeScript, PHP, .NET o Go, revisa sus requisitos y configura el cliente: entorno, timeout, reintentos y cliente … Primeros pasos · 5 minutos Primera llamada (quickstart)En cinco pasos: configura la llave, crea el cliente, valida la llave y sus scopes, consulta un afiliado y radica un crédito en el sandbox con su Idempotency-Key. Primeros pasos Entornos y llavesProducción, sandbox y dev: sus URL base, cómo se eligen en cada SDK y por qué el comportamiento (simulado o real) lo decide la llave y no la URL.