saltar al contenido principal
Explorar la documentación

Configuración del widget

Configura el widget con atributos data-* en la etiqueta de script.

Configuras el widget con atributos data-* en la etiqueta de script. Este es el conjunto completo.

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_test_..."
  data-position="bottom-left"
  data-env="development"
  data-chat-size="large"
  data-locale="fr"
  data-config-load="eager"
></script>
Un ejemplo completo: clave de desarrollo, lanzador abajo a la izquierda, panel grande, interfaz en francés y configuración cargada de inmediato.

Atributos principales

  • data-key — tu clave publicable (pk_test_… o pk_live_…). Obligatorio.
  • data-enabled — establece false para cargar el script pero no montar el widget (true por defecto).
  • data-position — esquina del lanzador: bottom-right (por defecto), bottom-left, top-right o top-left.
  • data-locale — fija el idioma y la dirección de esta página (por ejemplo ar o en-US). Si lo omites, el widget sigue automáticamente el idioma de tu página.
  • data-chat-size — small (por defecto), medium, large, fullscreen o embedded.
  • data-chat-mode — normal (por defecto) o split (un diseño de dos paneles).
  • data-env — development o production (si no, se infiere del prefijo de la clave).
  • data-theme — una cadena JSON con anulaciones de tokens de tema.

El widget sigue el idioma de tu página por sí solo: no hace falta ningún atributo. Lee tu <html lang> y, cuando tu página muestra una escritura distinta de la que declara, se fía de lo que aparece en pantalla. Usa tu propio selector de idioma y el chat lo sigue, en el cliente, sin recargar y sin perder la conversación. Usa data-locale solo si quieres anularlo en una página concreta.

El primer mensaje de tu visitante fija el idioma de la conversación, y ahí se queda aunque después cambie el idioma de tu sitio: una conversación iniciada en hebreo sigue respondiendo en hebreo. Las etiquetas del widget y el aviso de IA siguen a tu página, de modo que el aviso siempre se lee en el idioma en el que está navegando. Si quiere cambiar de idioma, basta con que lo pida en el chat.

Atributos avanzados

  • data-origin — el origen de la API de Syncanix (por defecto, la API de producción).
  • data-theme-name — selecciona un diseño con nombre de tu biblioteca; auto sigue el ajuste claro/oscuro del sitio.
  • data-prompt-profile — ejecuta en esta página un perfil de prompt concreto, por el nombre con el que lo publicaste. Solo pueden nombrarse los perfiles publicados; cualquier otro valor recurre a tu perfil activo.
  • data-mount-target — un selector CSS para dónde montar un widget incrustado.
  • data-split-page — la URL de la página que se muestra junto al chat en el modo split.
  • data-config-load — lazy (cargar los ajustes al abrir por primera vez, por defecto) o eager (al montar).
  • data-executor — el nombre de una función global que ejecuta acciones del navegador o del host.
  • data-token-provider — el nombre de una función global que devuelve el token del usuario final.
  • data-step-up-provider — el nombre de una función global que activa la reautenticación reforzada.
  • data-headers-provider — el nombre de una función global que devuelve encabezados de solicitud adicionales.
  • data-client-witness — activa la observación pasiva del tráfico de la API, solo de su forma (desactivado por defecto).
  • data-act-on-behalf-consent — exige un consentimiento único de «actuar en tu nombre» (desactivado por defecto).

Próximos pasos