API Reference

Integre análise de CRM com IA diretamente no seu sistema.

Autenticação

Todas as chamadas exigem uma API key no header X-API-Key.

curl -H "X-API-Key: clv_live_SUA_CHAVE" \
  "https://web-production-c00ce.up.railway.app/api/analisar?empresa=MinhaEmpresa&db=postgresql://..."

Endpoints

GET/api/analisar

Analisa o CRM e retorna insights, segmentação RFM e campanhas geradas por IA.

Parâmetros

ParâmetroTipoObrigatórioDescrição
empresastringSimNome da empresa para o relatório
dbstringSimConnection string do banco (PostgreSQL, SQLite)

Exemplo de resposta

{
  "empresa": "Loja XYZ",
  "gerado_em": "2026-06-17T14:30:00",
  "plano": "pro",
  "uso_mes": 3,
  "limite_mes": 100,
  "resumo": {
    "total_clientes": 1250,
    "total_pedidos": 4830,
    "receita_total": 890500.00,
    "ticket_medio": 184.37
  },
  "inativos": {
    "total_inativos": 320,
    "receita_potencial": 145200.00,
    "top_inativos": [ ... ]
  },
  "churn": { "total_em_risco": 45, "top_em_risco": [ ... ] },
  "upsell": { "total_candidatos": 87, "potencial_aumento_ticket": 64.53, ... },
  "rfm": [ {"segmento":"Campeões","clientes":89,"receita_total":320000.00, ...} ],
  "ia": {
    "resumo_executivo": [ "...", "...", "..." ],
    "alerta_principal": "...",
    "campanhas": [ { "nome":"...", "objetivo":"...", "canal":"...", "roi_estimado":"Alto" } ]
  }
}

Planos

Starter
R$ 197/mês
10 análises/mês
Pro
R$ 497/mês
100 análises/mês
Enterprise
R$ 1.497/mês
1.000 análises/mês

Exemplo em Python

import requests

resp = requests.get(
    "https://web-production-c00ce.up.railway.app/api/analisar",
    headers={"X-API-Key": "clv_live_SUA_CHAVE"},
    params={
        "empresa": "Minha Loja",
        "db": "postgresql://usuario:senha@host:5432/banco"
    }
)
data = resp.json()
print(data["resumo"]["total_clientes"])
print(data["ia"]["alerta_principal"])

Exemplo em JavaScript

const resp = await fetch(
  "https://web-production-c00ce.up.railway.app/api/analisar" +
  "?empresa=Minha+Loja&db=postgresql://usuario:senha@host/banco",
  { headers: { "X-API-Key": "clv_live_SUA_CHAVE" } }
);
const data = await resp.json();
console.log(data.resumo.receita_total);
console.log(data.ia.campanhas);

Erros comuns

CódigoMensagemSolução
401API key obrigatóriaPasse o header X-API-Key
403Key inválida ou limite atingidoVerifique sua chave ou faça upgrade de plano
400Falha na conexãoVerifique a connection string do banco

Para adquirir sua API key: cluve.ia

Cluve.ia · cluve.ia · API v1