Documentación para Desarrolladores
Guía completa para integrar WhatSurvey en tus aplicaciones y comenzar a enviar mensajes por WhatsApp.
Integración WhatsApp
Conecta tu número de WhatsApp y envía mensajes directamente desde tu aplicación.
API Sencilla
API REST fácil de usar con autenticación por API Keys y respuestas en JSON.
Requisitos mínimos
Solo necesitas un número de WhatsApp activo y la capacidad de vincular dispositivos (similar a WhatsApp Web).
Crear Cuenta
Crea tu cuenta para comenzar a usar la plataforma
Para comenzar a usar WhatSurvey, necesitas crear una cuenta. El proceso es rápido y sencillo.
1Proceso de Registro
Completar Formulario
Proporciona tu email y una contraseña segura (mínimo 8 caracteres).
Verificación por Email
Recibirás un email de confirmación para activar tu cuenta.
Cuenta Activa
Una vez confirmado el email, podrás acceder a todas las funcionalidades.
2Confirmación por Email
Tu contraseña se almacena de forma segura usando tecnologías de encriptación estándar. La verificación por email es obligatoria para proteger tu cuenta.
Iniciar Sesión
Accede a tu cuenta
Una vez que hayas creado tu cuenta, puedes iniciar sesión usando tu email y contraseña.
Acceso a la Plataforma
Introduce Credenciales
Ingresa tu email y contraseña en el formulario de login.
Verificación Automática
El sistema verifica automáticamente tus credenciales de forma segura.
Acceso Concedido
Si las credenciales son correctas, accederás al panel principal.
Sesión Activa
Tu sesión permanece activa mientras uses la plataforma.
Si no recuerdas tu contraseña, puedes usar la función de recuperación desde la página de login.
Conectar WhatsApp
Vincula tu número de WhatsApp a la plataforma
Para enviar mensajes, necesitas conectar tu número de WhatsApp. El proceso es similar a vincular WhatsApp Web.
!Requisitos
Número WhatsApp Activo
Un número de WhatsApp funcionando en tu teléfono móvil.
Capacidad Multi-dispositivo
WhatsApp debe tener activada la función multi-dispositivo.
1Proceso de Conexión
Ir a Configuración
En tu panel, dirígete a la sección "WhatsApp" y haz clic en "Conectar Número".
Escanear Código QR
Se generará un código QR que debes escanear desde tu WhatsApp móvil.
Conexión Exitosa
Una vez conectado, podrás enviar mensajes a través de la API.
2Escaneo QR
1. Abre WhatsApp en tu teléfono
2. Ve a Configuración → Dispositivos Vinculados
3. Toca "Vincular un dispositivo"
4. Escanea el código QR mostrado en la plataforma
API Keys
Autenticación segura para tu aplicación
Las API Keys te permiten autenticarte de forma segura cuando envías mensajes desde tu aplicación.
1Crear API Key
Acceder a API Keys
En tu panel, ve a la sección API Keys en el menú lateral.
Generar Nueva Key
Haz clic en “Crear Nueva API Key” y asigna un nombre descriptivo.
Copiar y Guardar
Copia la API Key generada y guárdala en un lugar seguro. Solo se muestra una vez.
2Seguridad
Mantén Seguras tus Keys
- • No las compartas públicamente
- • No las incluyas en repositorios de código
- • Usa variables de entorno
Gestión Recomendada
- • Crea keys específicas por proyecto
- • Revoca keys que no uses
- • Rota keys periódicamente
Envío de Mensajes
Cómo enviar mensajes usando la API
Una vez que tengas tu WhatsApp conectado y tu API Key, puedes empezar a enviar mensajes programáticamente.
1Endpoint de Mensajes
/api/messagesEndpoint principal para envío de mensajes de texto por WhatsApp.
2Autenticación
Header Requerido
X-API-Key: Bearer tu_api_key_aquiIncluye tu API Key en el header X-API-Key con el prefijo “Bearer ”.
3Ejemplos de Uso
Formato JSON del mensaje
{
"sessionName": "nombre-de-la-sesion-creada",
"chatId": "521XXXXXXXXXX@c.us",
"text": "¡Hola! Te contactamos desde nuestra empresa.",
}4Respuestas
✓ Éxito (200)
{
"ok": true,
"message": "Mensaje enviado exitosamente",
"data": {
"sessionName": "prueba",
"chatId": "521XXXXXXXXXX@c.us",
"timestamp": "2025-11-03T17:23:07.422Z"
}
}✗ Error (400/401)
{
"ok": false,
"message": "API Key no válida o cuenta sin API Key activa"
}Mejores Prácticas
Recomendaciones para uso óptimo
Sigue estas recomendaciones para obtener los mejores resultados y mantener una buena reputación en WhatsApp.
1Seguridad
🚫 Evita
- • Compartir tu API Key públicamente
- • Incluir credenciales en el código fuente
- • Usar la misma API Key en múltiples proyectos
- • Dejar API Keys sin usar activas
✅ Recomendado
- • Usa variables de entorno
- • Crea API Keys específicas por proyecto
- • Rota tus API Keys regularmente
- • Revoca keys que no necesites
2WhatsApp
Respeta las políticas de WhatsApp
- • No envíes spam o mensajes no solicitados
- • Respeta los límites de velocidad
- • Obtén consentimiento antes de enviar mensajes
- • Proporciona una forma fácil de darse de baja
Mantén una buena reputación
- • Envía contenido relevante y valioso
- • Responde rápidamente a las consultas
- • Evita enviar demasiados mensajes seguidos
- • Usa horarios apropiados para enviar mensajes
3Uso de API
Rendimiento
- • Implementa reintentos con backoff exponencial
- • Maneja errores apropiadamente
- • No envíes requests simultáneos excesivos
- • Monitorea el estado de tus mensajes
Debugging
- • Guarda logs de todas las requests
- • Verifica el formato de números de teléfono
- • Valida el contenido antes de enviar
- • Prueba con números de test primero