REST API v1

API Documentation

Integre o LinkMágico™ ao seu sistema. Capture leads, processe mensagens e gerencie assistentes via API REST.

Autenticação
Todas as requisições autenticadas requerem sua API Key.

Como autenticar

Header: X-API-Key: sua_api_key
Query param: ?apiKey=sua_api_key
Body JSON: "apiKey": "sua_api_key"
Obtenha sua API Key no painel administrativo → campo "Sua API Key"
Endpoints
Clique em cada endpoint para ver detalhes, parâmetros e exemplos.
POST /api/capture-lead Capturar um novo lead

Parâmetros (Body JSON)

CampoTipoObrigatórioDescrição
nomestringSimNome do lead
emailstringNãoEmail do lead
telefonestringNãoTelefone (formato E.164)
url_origemstringNãoURL de onde o lead veio
robotNamestringNãoNome do assistente

Exemplo — cURL

bash
# Capturar um lead
curl -X POST https://linkmagico.app.br/api/capture-lead \
  -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{
    "nome": "João Silva",
    "email": "joao@email.com",
    "telefone": "+5511999999999",
    "url_origem": "https://meusite.com"
  }'

Resposta (200 OK)

json
{
  "success": true,
  "leadId": "lead_abc123",
  "message": "Lead capturado com sucesso"
}
POST /api/process-chat-inteligente Enviar mensagem ao chat IA

Parâmetros (Body JSON)

CampoTipoObrigatórioDescrição
messagestringSimMensagem do usuário
robotNamestringSimNome do assistente
leadIdstringNãoID do lead (para contexto)
conversationIdstringNãoID da conversa (continuidade)

Exemplo — JavaScript (fetch)

javascript
const response = await fetch('https://linkmagico.app.br/api/process-chat-inteligente', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'SUA_API_KEY'
  },
  body: JSON.stringify({
    message: 'Quero saber sobre o produto',
    robotName: 'MeuAssistente'
  })
});
const data = await response.json();
console.log(data.response); // Resposta da IA

Resposta (200 OK)

json
{
  "success": true,
  "response": "Olá! Posso ajudar com informações...",
  "conversationId": "conv_xyz789"
}
POST /api/track-conversion Rastrear evento de conversão

Parâmetros (Body JSON)

CampoTipoObrigatórioDescrição
apiKeystringSimAPI Key do tenant
typestringSim"cta_click" ou "checkout_click"
urlstringNãoURL do link clicado
leadIdstringNãoID do lead que clicou

Exemplo — cURL

bash
curl -X POST https://linkmagico.app.br/api/track-conversion \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "SUA_API_KEY",
    "type": "checkout_click",
    "url": "https://pay.hotmart.com/xxx"
  }'
GET /api/conversion-stats Métricas de conversão do tenant

Autenticação

Requer X-API-Key ou ?apiKey=

Resposta (200 OK)

json
{
  "success": true,
  "stats": {
    "totalCtaClicks": 142,
    "totalCheckoutClicks": 38,
    "conversionRate": "26.8%",
    "last7days": [
      { "date": "2026-05-20", "cta": 22, "checkout": 6 }
    ]
  }
}
POST /admin/leads/backup/create Criar backup dos leads

Autenticação

Requer X-API-Key

Exemplo — cURL

bash
curl -X POST https://linkmagico.app.br/admin/leads/backup/create \
  -H "X-API-Key: SUA_API_KEY"

Rate Limits

As chamadas à API são limitadas conforme seu plano:

PlanoMensagens/mêsChatbotsLeads
Starter5001100
Pro2.0003500
Scale10.000102.000