Documentación
Integrar el widget
Una sola etiqueta de script antes de cerrar el cuerpo de la página. Sin dependencias, sin descargar nada de servidores de otras empresas, sin cambios en su código.
El fragmento de código
La clave de su organización está en el panel. Es pública por diseño y vive en el código fuente de su página.
<script src="https://aivatary.com/assets/caip-widget.js"
data-tenant-key="pw_0123456789abcdef"
data-api-base="https://app.aivatary.com"
defer></script>Por qué la clave puede ser pública
La clave de la organización no es un secreto. El widget la canjea por un token de sesión de vida corta, y el acceso queda además limitado por la lista de dominios permitidos. Ningún secreto llega nunca al navegador, así que copiar el fragmento en la página de otra persona no sirve de nada.
Atributos opcionales
| Atributo | Por defecto | Significado |
|---|---|---|
| data-tenant-key | obligatorio | La clave pública de su organización |
| data-api-base | obligatorio | La dirección en la que funciona la plataforma |
| data-theme-attr | data-theme | Nombre del atributo del elemento html del que se lee el tema |
| data-locale | idioma de la página y luego pl | Idioma de la sesión: pl o en |
| data-auto-open | desktop | Apertura automática del panel: desktop para ventanas a partir de 900 píxeles, always, never |
| data-avatar-selector | [data-caip-avatar] | Selector del contenedor que debe ocupar el avatar en modo hero |
Tema
- Cómo se lee
- El widget mira el atributo que indica data-theme-attr en el elemento html. El valor light significa tema claro; cualquier otro valor, o la ausencia del atributo, significa oscuro.
- Sin recargar
- Un cambio de tema en su página surte efecto de inmediato, porque el widget vigila las modificaciones del atributo.
- Preferencia del sistema
- El widget ignora a propósito el ajuste claro y oscuro del sistema operativo, igual que esta web. Decide su atributo, para que el widget nunca se separe del resto de la página.
La lista de dominios permitidos
- Dónde se configura
- En los ajustes de la organización, una entrada por cada dominio en el que el widget deba responder.
- Qué ocurre fuera de la lista
- Una petición procedente de un dominio que no está en la lista no se atiende. Esa es justamente la razón por la que la clave pública no tiene que ser secreta.
- Entorno de pruebas
- Un dominio de pruebas hay que añadirlo aparte. Una dirección local también es un dominio.
El widget no aparece
¿Está el dominio en la lista de dominios permitidos?
La causa más frecuente. Compruebe que está anotado exactamente el dominio desde el que abre la página, junto con el prefijo www si lo hubiera.
¿Se ha cargado el script?
En la pestaña de red de las herramientas del navegador debería verse el archivo del widget. El bloqueo por una extensión de bloqueo de publicidad es la segunda causa más frecuente.
¿Es correcta la clave?
La clave empieza por el prefijo pw_ y procede del panel de su organización. Una clave de otro entorno no funcionará.
¿La página carga el widget dos veces?
El widget se protege de la carga doble, pero dos claves distintas en una misma página son un conflicto de configuración, no un caso que haya que atender.
¿Hay algo que tape el widget?
Un elemento con un valor de apilamiento muy alto puede ocultarlo. El widget se dibuja en su propio árbol, así que esto no se arregla con su hoja de estilos: hay que bajar la capa del elemento que tapa.
Lo siguiente: el avatar en la página
Si quiere que la conversación arranque donde está el personaje y no en una burbuja en la esquina, pase al modo hero.