Guía de integración para desarrolladores
Resumen para desarrolladores
WebChatAgent ofrece tres formas de poner un Chatbot a disposición de los usuarios. Elija una según el nivel de control que necesite sobre la interfaz.
| Integración | Qué obtiene | Ideal para |
|---|---|---|
| Incrustación del Widget | Una interfaz de chat lista para usar con una sola etiqueta de script | Sitios web y aplicaciones web |
| REST API | Envíe un mensaje y reciba una respuesta (solicitud/respuesta) | Interfaces personalizadas, aplicaciones móviles, scripts de servidor |
| WebSocket API | Flujo de mensajes en tiempo real con indicadores de escritura y presencia | Paneles de Chat en vivo, herramientas de agente |
Las tres opciones se comunican con el mismo Chatbot, comparten la misma Base de conocimiento y consumen la misma cuota de mensajes. Puede combinarlas, por ejemplo, incrustando el Widget en su sitio y creando un Panel de agentes interno sobre la WebSocket API.
Incrustación del Widget (el más rápido)
Añada el Chatbot a cualquier Sitio web con una sola etiqueta de script y un elemento HTML personalizado (<web-chat-agent chatbot-id="...">). Sin frameworks ni pasos de compilación. Todos los colores, textos y herramientas se configuran en el Panel y se aplican automáticamente. Es la opción adecuada para el 90% de los sitios web.
- Guía de incrustación del Widget, Etiqueta de script, elemento personalizado, todos los atributos HTML, CSS personalizado, modo integrado y uso en SPA
REST API
Cuando necesite su propia interfaz de chat, como una aplicación Móvil, un componente web personalizado o una automatización en el backend, llame directamente al endpoint de chat. Envíe un message junto con su chatbotId y reciba una reply generada por IA con sus fuentes. El ID de sesión devuelto en la cabecera de la respuesta mantiene la coherencia en las conversaciones de varios turnos.
- Referencia de la REST API, Endpoints, autenticación por Dominio, campos de solicitud/respuesta, códigos de error y ejemplos de código en cURL, JavaScript, Python y PHP
WebSocket API
Para Chat en vivo, donde los mensajes deben llegar al instante y necesita indicadores de escritura, presencia y traducción automática. El mismo socket alimenta los widgets de los visitantes y el Panel de agentes. Utilícelo para crear una consola de agentes personalizada o para gestionar el Chat en vivo desde su propio backend.
- Referencia de la WebSocket API, Conexión, roles, eventos enviados y recibidos, y un ejemplo de cliente funcional
¿Cuál debo utilizar?
| Caso de uso | Recomendado |
|---|---|
| Añadir un Chatbot a un Sitio web | Incrustación del Widget |
| Renderizar el chat dentro del diseño de su propia página | Chat integrado (incrustación del Widget) |
| Interfaz de chat personalizada o aplicación Móvil | REST API |
| Automatización entre servidores (sin interfaz gráfica) | REST API |
| Panel de Chat en vivo en tiempo real para agentes humanos | WebSocket API |
Consulte Casos de uso para ver escenarios concretos que estas integraciones hacen posibles.