API Overview

La API de ChurnCut te permite integrar funcionalidades de retención de forma programática en tu aplicación.

¿Estás empezando?

Consulta nuestra guía Quickstart para integrar ChurnCut en minutos con instrucciones paso a paso.

Base URL

https://api.churncut.com/v1

Authentication

Todas las solicitudes requieren tu API Key en el header Authorization:

Authorization: Bearer your-api-key

Note: Tu API Key es diferente de tu Secret Key. La API Key se usa para solicitudes server-to-server, mientras que la Secret Key se usa para generar tokens HMAC.

Formato de respuesta

Todas las respuestas usan JSON:

json

{
  "success": true,
  "data": { ... }
}

En caso de error:

json

{
  "success": false,
  "error": {
    "code": "invalid_token",
    "message": "The HMAC token is invalid or has expired"
  }
}

Rate limiting

1000 solicitudes por minuto por API Key.

Los headers de respuesta incluyen:

X-RateLimit-Limit: Total limit
X-RateLimit-Remaining: Remaining requests
X-RateLimit-Reset: Reset timestamp

Endpoints

Method	Endpoint	Descripción
GET	/customers	Listar clientes con estado de riesgo
GET	/customers/:id	Obtener un cliente específico
POST	/cancellation-flows	Iniciar un flujo de cancelación
GET	/cancellation-flows/:id	Obtener estado del flujo
GET	/analytics/churn	Métricas de churn
GET	/analytics/retention	Métricas de retención

SDKs

Ofrecemos SDKs oficiales para:

Ejemplo rápido

javascript

const response = await fetch('https://api.churncut.com/v1/customers', {
  headers: {
    'Authorization': 'Bearer your-api-key',
    'Content-Type': 'application/json'
  }
});

const { data } = await response.json();
console.log(data.customers);

Installation Endpoints