API Reference

API REST para integraciones personalizadas. Disponible en plan BUSINESS.

Autenticación

Todas las requests requieren header Authorization: Bearer YOUR_API_KEY. Genera tu API key en Settings → Integraciones.

Leads

GET  /api/leads?orgId=XXX&limit=50    # Listar leads
POST /api/leads                          # Crear lead
GET  /api/leads/:id                      # Obtener lead
PUT  /api/leads/:id                      # Actualizar lead
DEL  /api/leads/:id                      # Eliminar lead

Ejemplo: crear lead

curl -X POST https://leadvantage.es/api/leads \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Restaurante Ejemplo",
    "phone": "+34600123456",
    "email": "info@ejemplo.com",
    "source": "MANUAL",
    "orgId": "your-org-id"
  }'

Ejemplo: listar leads

curl https://leadvantage.es/api/leads?orgId=XXX&limit=50   -H "Authorization: Bearer YOUR_API_KEY"

Campañas

GET  /api/campaigns?orgId=XXX            # Listar campañas
POST /api/campaigns                      # Crear campaña
POST /api/campaigns/:id/activate         # Activar campaña
POST /api/campaigns/:id/pause            # Pausar campaña

Mensajes

GET  /api/messages?orgId=XXX&leadId=YYY  # Mensajes de un lead
POST /api/messages                        # Enviar mensaje

Ejemplo: enviar mensaje

curl -X POST https://leadvantage.es/api/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leadId": "lead-id",
    "orgId": "org-id",
    "body": "Hola, te contactamos desde..."
  }'

Scraper

POST /api/scraper/jobs                    # Crear job de scraping
GET  /api/scraper/jobs/:id                # Estado del job
GET  /api/scraper/jobs/:id/results        # Resultados del job

Pipeline

GET  /api/pipeline?orgId=XXX              # Listar stages
POST /api/pipeline                         # Crear stage
PUT  /api/pipeline/:id                     # Actualizar stage

Rate limits

100 requests por minuto por API key. Contacta con soporte para límites personalizados.

Errores

La API usa códigos HTTP estándar:

200 — OK
400 — Bad Request (validación)
401 — Unauthorized (API key inválida)
403 — Forbidden (sin permisos)
404 — Not Found
429 — Rate limit exceeded
500 — Server error

← AnteriorConfiguración