Guía de integración para desarrolladores

Resumen para desarrolladores

WebChatAgent ofrece tres formas de poner un chatbot frente a sus usuarios. Elija una según el nivel de control que necesite sobre la interfaz.

IntegraciónLo que obtieneIdeal para
Integración mediante WidgetUna UI de chat lista para usar desde una sola etiqueta de scriptSitios web y aplicaciones web
REST APIEnviar un mensaje, recibir una respuesta (petición/respuesta)UIs personalizadas, aplicaciones móviles, scripts de servidor
WebSocket APIFlujo de mensajes en tiempo real con indicadores de escritura y presenciaPaneles de Chat en vivo, herramientas de agentes
SDK de JavaScriptPaquete de npm con tipos para la REST API y la WebSocket APIUIs de chat personalizadas en JavaScript o TypeScript
WebhookNuevos leads y citas como solicitud JSON firmada a su servidorSincronización con el CRM, automatizaciones

Las tres opciones se comunican con el mismo chatbot, comparten la misma Base de conocimiento y cuentan para la misma cuota de mensajes. Puede combinarlas, por ejemplo, insertar el Widget en su sitio y crear un Panel de agentes interno sobre la WebSocket API.

Integración mediante 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, sin paso de compilación. Todos los colores, textos y herramientas se configuran en el Panel y se aplican automáticamente. Esta es la opción adecuada para el 90% de los sitios web.

REST API

Cuando necesite su propia interfaz de chat, ya sea una aplicación móvil, un componente web personalizado o una automatización en el backend, llame directamente al endpoint de chat. Envía un message junto con su chatbotId y recibe una reply generada por IA con sus fuentes. Un ID de sesión devuelto en una cabecera de respuesta mantiene la coherencia en conversaciones de varios turnos.

  • Referencia de la REST API: endpoints, autenticación de Dominio, campos de petición/respuesta, códigos de error y ejemplos de código en cURL, JavaScript, Python y PHP

SDK de JavaScript

¿Está creando una UI de chat personalizada en JavaScript o TypeScript? El paquete de npm webchatagent envuelve la REST API y la WebSocket API: respuestas en streaming, Carga de archivos, Comentarios, Formularios para captar clientes potenciales y Chat en vivo con su equipo, con tipos completos de TypeScript y sin dependencias.

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 para 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.

¿Cuál debo utilizar?

Caso de usoRecomendado
Añadir un chatbot a un Sitio webIntegración mediante Widget
Renderizar el chat dentro del diseño de su propia páginaChat integrado (integración mediante widget)
UI de chat personalizada en JavaScript o TypeScriptSDK de JavaScript
UI de chat personalizada o aplicación móvilREST API
Automatización entre servidores (sin UI)REST API
Panel de Chat en vivo en tiempo real para agentes humanosWebSocket API

Consulte Casos de uso para ver escenarios concretos que estas integraciones hacen posibles.