Tu sistema llama a Whatsplaid para validar cuenta, gestionar contactos, etiquetas, campos, conversaciones, carrito, mensajes y atención humana.
API pública y documentación
Conecta sistemas propios a Whatsplaid con API, conectores y webhooks.
Usa la API pública cuando otro sistema necesite activar Whatsplaid. Usa el conector externo cuando el asistente necesite consultar productos, pedidos o datos de tu sistema durante la conversación. Usa webhooks para recibir eventos capturados en WhatsApp.
Tres contratos
Elige el sentido correcto de la integración.
La documentación Swagger separa los flujos para evitar confusión entre llamadas a Whatsplaid, consultas realizadas por el asistente y eventos enviados a tu sistema.
Whatsplaid llama a tu sistema para consultar productos, pedidos, clientes o disponibilidad en tiempo real durante una conversación.
Whatsplaid envía eventos a una URL tuya. El evento disponible en el panel es el lead capturado durante la conversación.
El Swagger en `api.whatsplaid.com/docs/` contiene los esquemas, ejemplos, respuestas esperadas y contratos técnicos completos.
Referencia rápida de los principales endpoints.
Esta vista resume los recursos que aparecen en la documentación oficial. La implementación final debe seguir el Swagger.
GET
/store
Retorna datos de la cuenta, comercio electrónico conectado y módulos activos.
Account
GET
/modules
Lista de módulos activos, como leads, consultor de ventas, post-venta, base de conocimientos y carrito.
Account
GET
/ecommerce/products/search
Busca productos en las integraciones nativas conectadas, como Nuvemshop, Wix o Shopify.
Ecommerce
GET
/ecommerce/orders/search
Busca pedidos por número, correo electrónico o teléfono en las integraciones nativas conectadas.
Ecommerce
POST
/contacts
Crea o actualiza contacto usando teléfono como clave principal.
Contacts
PATCH
/contacts/{contactId}/custom-fields
Actualiza campos personalizados para segmentación y contexto operacional.
Fields
POST
/messages/send
Envía mensaje de texto dentro de la ventana de atención de 24 horas de WhatsApp.
Messaging
POST
/handoffs
Solicita atención humana usando la configuración actual de la empresa.
Handoff
Contratos técnicos
La documentación cubre API, conector externo y webhooks.
El menú de integraciones del ADMIN usa la misma separación: API pública de Whatsplaid, conector externo para consultas en sistemas propios y webhook de salida para leads capturados.
Valida cuenta, módulos, contactos, etiquetas, campos personalizados, mensajes, conversaciones, carrito y atención humana.
Su sistema expone endpoints como `/products/search` y `/orders/search` para que Whatsplaid consulte durante la conversación.
Retorno esperado con `products`, incluyendo ID, nombre, descripción, precio, disponibilidad, stock, URL e imagen.
Retorno esperado con `orders`, incluyendo número, estado, pago, entrega, total, cliente, rastreo y artículos.
El evento `LEAD_CAPTURE` envía datos del lead a la URL configurada. El endpoint debe responder HTTP 200 o 204.
Usa `Authorization: Bearer` en las llamadas. Los tokens no deben exponerse en el frontend público.
¿Necesitas implementar o validar una integración?
Abre la documentación interactiva para alternar entre `Whatsplaid Public API`, `Custom Data Connector Contract` y `Outgoing Webhooks`.