Ir al contenido
KeuralDocs
Desarrolladores

Chatbot

Añada un botón de chatbot de Keural al sitio web de su organización con un código de instalación.

Una organización puede añadir un chatbot de Keural a su sitio web. Cuando un visitante hace clic en el botón de una esquina de la pantalla, se abre una ventana de chat. Se instala pegando en su sitio el código de instalación creado en la pantalla de administración.

Crear un chatbot

  1. Un propietario o administrador de la organización hace clic en + Añadir chatbot en Gestión de la organización → Chatbots.
  2. Introduzca un nombre de chatbot y un dominio base (por ejemplo, https://example.com) y regístrelo.
  3. Abra el chatbot y configure tres pestañas.
PestañaConfiguración
Token e instalaciónRevise el token y copie el código de instalación (HTML · Next.js)
Interfaz del chatbotImagen del botón (PNG, JPG, GIF, WebP) y su visibilidad, nombre del chatbot, visualización del encabezado, expansión y color, color del botón, posición del botón (izquierda o derecha), y desplazamientos horizontal y vertical. Compruébelo con la vista previa
AvanzadoDirecciones de página en las que el chatbot puede abrirse (dominios permitidos, hasta 5)
  1. Pegue el código de instalación en su sitio web.

Código de instalación

En la pestaña Token e instalación, copie el código para HTML o para Next.js. El código tiene dos partes.

  • Cargador: crea la función Keural y, cuando termina de cargarse la página, carga de forma asíncrona el script del chatbot (/plugin/keural-widget@1.0.1.js). Los comandos que se llamen antes de que llegue el script se acumulan en una cola y se ejecutan en orden.
  • Comando de inicio: Keural('boot', { token: '…' }). El token empieza por wgt_.

La versión del script está fijada en la dirección. Cuando salga una versión nueva, copie de nuevo el código de instalación y reemplácelo. Si pega el código de instalación dos veces en la misma página, la segunda copia se ignora y se registra un error en la consola.

<script id="keural-one-script">
  /* Código copiado de la pestaña Token e instalación */
</script>

En Next.js, colóquelo con <Script id="keural-one-script" strategy="afterInteractive"> de next/script. Para mostrarlo en todas las páginas, colóquelo en el layout raíz.

Opciones de inicio

Los valores que pase a boot tienen prioridad sobre la configuración de la pantalla de administración. Úselos para cambiar el aspecto por página.

Keural('boot', {
  token: 'wgt_…',
  theme: 'system',
  header: { enabled: true, extended: true, draggable: true, title: 'Soporte al cliente', color: '#495BD8' },
  button: { visible: true, iconUrl: 'https://example.com/icon.png', color: '#495BD8', position: 'right', offsetX: 30, offsetY: 30 },
});
OpciónValorNombre del ajuste en pantalla
tokenObligatorio. Token del código de instalación—
themelight · dark · system—
header.enabledMostrar el encabezadoMostrar encabezado
header.extendedMuestra el botón de vista ampliada en el encabezadoExpandir encabezado
header.draggablePermite arrastrar el encabezado para mover la ventana (predeterminado true)—
header.titleTítulo del encabezadoNombre del chatbot
header.colorColor del encabezadoColor del encabezado
button.visibleMostrar el botónMostrar botón
button.iconUrlDirección de la imagen del botónImagen del botón
button.colorColor del botónColor del botón
button.positionleft · rightPosición del botón
button.offsetX · button.offsetYDistancia desde el borde de la pantalla (px)Desplazamiento X · Desplazamiento Y

Los valores predeterminados de un chatbot nuevo son: encabezado visible y expandido, color del encabezado y del botón #495BD8, a la derecha, desplazamiento de 30 px, tema system.

Control desde la página

LlamadaAcción
Keural('open') · Keural.open()Abre la ventana del chatbot.
Keural('close') · Keural.close()La cierra.
Keural('toggle') · Keural.toggle()Si está abierta, la cierra; si está cerrada, la abre.
Keural('reload') · Keural.reload()Vuelve a cargar la ventana del chatbot.
Keural('badge', n) · Keural.badge(n)Muestra una insignia numérica en el botón.
Keural.isLoaded()true si el script ya se cargó por completo
Keural.onOpen(cb) · Keural.onClose(cb)Llama a cb cuando la ventana se abre o se cierra.

Los métodos como Keural.open() solo funcionan después de cargar el script. Si los llama justo al cargar la página, use la forma de función Keural('open'), que se ejecuta en orden.

<button onclick="Keural('open')">Consultar</button>

También puede ocultar el botón predeterminado (button.visible: false) y abrir el chatbot desde un botón de su página.

Tamaño de la pantalla

La ventana del chatbot mide 390×800 px y, si el ancho de la pantalla es de 480 px o menos, se abre a pantalla completa. Amplíe la ventana con el botón de vista ampliada del encabezado.

Dominios de visualización

  • El chatbot se abre en páginas cuyo host coincide con el dominio base. El host se compara incluyendo el puerto, sin distinguir mayúsculas de minúsculas. Una dirección con www. y un subdominio son hosts distintos. Para probar en un servidor de desarrollo, cree otro chatbot con esa dirección como dominio base.
  • El dominio base no se puede cambiar después de crearlo. Para cambiarlo, cree un chatbot nuevo.
  • Si deja vacíos los dominios permitidos de Avanzado, el chatbot se abre en todas las páginas del dominio base. Si añade dominios permitidos, solo se abre en las páginas que empiezan por esas direcciones. Si incluye la ruta, como https://example.com/help, se limita a las páginas bajo esa ruta. Los dominios permitidos empiezan por http:// o https://, y puede añadir hasta 5.
  • El token del código de instalación queda visible en la página. Conecte al chatbot solo contenido que pueda hacerse público.

Política de seguridad de contenido (CSP)

Si su sitio aplica Content-Security-Policy, permita lo siguiente. Las direcciones son según keural.ai.

DirectivaQué permitir
script-srchttps://keural.ai y el script en línea del código de instalación ('unsafe-inline' o hash o nonce)
connect-srchttps://api.keural.ai
frame-srchttps://keural.ai
style-src'unsafe-inline' o nonce (el chatbot añade estilos a la página)
img-srcLa dirección de la imagen del botón, https://keural.ai y https://api.keural.ai

En esta página