API
API de YaVendió
Conecta tu ERP, CRM u otros sistemas vía API
Overview
La API REST de YaVendió te permite enviar mensajes, consultar conversaciones, sincronizar contactos y disparar flujos desde cualquier sistema externo. Autenticación con API key y webhooks salientes para eventos en tiempo real.
Before you start
- Una cuenta de YaVendió en plan Pro o superior
- Permisos de admin en el workspace
- Un endpoint público para recibir webhooks (opcional)
Step by step
1. Genera tu API key
Panel de YaVendió → Configuración → API → "Crear nueva clave". Asigna un nombre descriptivo y copia la clave; solo se muestra una vez.
Guarda la clave en un secret manager (1Password, AWS Secrets, etc.). Nunca la pongas en código del lado cliente.2. Haz tu primera llamada
Prueba el endpoint /v1/conversations con curl para confirmar que la autenticación funciona.
curl https://api.ya.onl/v1/conversations \ -H "Authorization: Bearer YOUR_API_KEY"3. Configura webhooks salientes
Para recibir eventos en tu sistema (mensaje recibido, venta cerrada, contacto nuevo), registra una URL en Configuración → Webhooks. YaVendió firma cada payload con HMAC-SHA256.
4. Implementa el handler
En tu backend, valida la firma del header X-Yavendio-Signature antes de procesar el evento. Responde con 2xx en menos de 5 segundos o el envío se reintentará.
POST /webhook X-Yavendio-Signature: sha256=... { "event": "conversation.message_received", "data": { ... } }5. Suscríbete solo a los eventos que necesitas
En la pantalla de webhooks, filtra por tipos: solo mensajes entrantes, solo ventas, etc. Reduce ruido y costo de procesamiento.
Frequently asked questions
¿Hay rate limits?
300 requests/minuto por workspace en plan Pro, 1.500 rpm en Diamond. Los headers de respuesta incluyen X-RateLimit-Remaining.
¿Hay SDKs oficiales?
Tenemos SDKs no oficiales en TypeScript y Python mantenidos por la comunidad. Para producción se recomienda llamar al REST directo.
