Su sistema llama a Whatsplaid para validar cuentas, gestionar contactos, etiquetas, campos, conversaciones, carrito, mensajes y atención humana.
API pública y documentación
Conecte sus sistemas a Whatsplaid con API, conectores y webhooks.
Utilice la API pública cuando otro sistema necesite activar Whatsplaid. Use el conector externo cuando el asistente necesite consultar productos, pedidos o datos de su sistema durante la conversación. Use webhooks para recibir eventos capturados en WhatsApp.
Tres contratos
Elija la dirección correcta de la integración.
La documentación de Swagger separa los flujos para evitar confusiones entre las llamadas a Whatsplaid, las consultas realizadas por el asistente y los eventos enviados a su sistema.
Whatsplaid llama a su sistema para consultar productos, pedidos, clientes o disponibilidad en tiempo real durante una conversación.
Whatsplaid envía eventos a una URL que usted proporciona. 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 endpoints principales.
Esta vista resume las características que aparecen en la documentación oficial. La implementación final debe seguir el Swagger.
GET
/store
Devuelve datos de la cuenta, el comercio electrónico conectado y los módulos activos.
Account
GET
/modules
Lista de módulos activos, como leads, consultor de ventas, posventa, base de conocimiento y carrito.
Account
GET
/ecommerce/products/search
Busca productos en las integraciones nativas conectadas, como Nuvemshop, Wix o Shopify.
Ecommerce
GET
/ecommerce/orders/search
Buscar pedidos por número, correo electrónico o teléfono en las integraciones nativas conectadas.
Ecommerce
POST
/contacts
Crea o actualiza un contacto usando el teléfono como clave principal.
Contacts
PATCH
/contacts/{contactId}/custom-fields
Actualiza campos personalizados para segmentación y contexto operativo.
Fields
POST
/messages/send
Envía un mensaje de texto dentro de la ventana de atención de 24 horas de WhatsApp.
Messaging
POST
/handoffs
Solicitar atención humana usando la configuración actual de la empresa.
Handoff
Contratos técnicos
La documentación cubre la API, el conector externo y los 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`, que incluya ID, nombre, descripción, precio, disponibilidad, stock, URL e imagen.
Respuesta esperada con `orders`, incluyendo número, estado, pago, envío, total, cliente, seguimiento y artículos.
El evento `LEAD_CAPTURE` envía datos del lead a la URL configurada. El endpoint debe responder con HTTP 200 o 204.
Use `Authorization: Bearer` en las llamadas. Los tokens no deben exponerse en el frontend público.
¿Necesita implementar o validar una integración?
Abra la documentación interactiva para cambiar entre `Whatsplaid Public API`, `Custom Data Connector Contract` y `Outgoing Webhooks`.