Referencia del SDK de JavaScript del Widget

Referencia del SDK de JavaScript de Widget

El widget de Helpium es una aplicación de JavaScript autónoma que puedes incrustar en tu sitio web. Proporciona chat en vivo, búsqueda impulsada por IA y acceso a la base de conocimientos.

Instalación

Agrega el siguiente script a tu sitio web, justo antes de la etiqueta de cierre </body>:

<script>
(function() {
    var s = document.createElement('script');
    s.src = 'https://your-workspace.helpium.io/widget/helpium-widget.js';
    s.async = true;
    s.onload = function() {
        Helpium.init({
            apiKey: 'your_widget_key_here',
        });
    };
    document.head.appendChild(s);
})();
</script>

Helpium.init(options)

Inicializa el widget. Debe ser llamado antes de cualquier otro método.

Opciones:

Opción	Tipo	Descripción
apiKey	string	Requerido. Tu clave de widget del espacio de trabajo
baseUrl	string	URL base de API personalizada (para autoalojado)
primaryColor	string	Color hexadecimal para el tema del widget
contrastColor	string	Color hexadecimal para el texto sobre el color primario
backgroundColor	string	Color hexadecimal para el fondo del widget
backgroundColorSecondary	string	Color hexadecimal para superficies secundarias
borderColor	string	Color hexadecimal para los bordes
textColor	string	Color hexadecimal para el texto primario
textColorSecondary	string	Color hexadecimal para el texto secundario

Helpium.identify(customer)

Identifica al usuario actual para soporte personalizado. Llama a esto después de que tu usuario inicie sesión.

Helpium.identify({
    email: 'jane@example.com',
    name: 'Jane Smith',
    id: 'user_123',
    bearerToken: 'sanctum_token_here',
    avatarUrl: 'https://example.com/avatar.jpg',
    metadata: {
        company: 'Acme Corp',
        role: 'Admin',
        plan: 'Pro',
    }
});

Parámetros:

Parámetro	Tipo	Descripción
email	string	Requerido. Dirección de correo electrónico del cliente
name	string	Nombre de visualización del cliente
id	string	Tu ID de usuario interno
bearerToken	string	Token de Sanctum para acciones de IA autenticadas
avatarUrl	string	URL a la imagen de avatar del cliente
metadata	object	Pares clave-valor personalizados mostrados a los agentes

Aislamiento de Estilo

El widget utiliza Shadow DOM para un completo aislamiento de estilo. El CSS de tu sitio web no afectará al widget, y los estilos del widget no filtrarán en tu página.

Conexión WebSocket

El widget establece automáticamente una conexión WebSocket para mensajería en tiempo real. No se necesita configuración adicional: los detalles de conexión se obtienen del endpoint de configuración del widget.

Aplicaciones de Página Única (SPAs)

Para SPAs como aplicaciones de React, Vue o Angular, llama a Helpium.init() una vez cuando tu aplicación se monte. El widget persiste a través de cambios de ruta del lado del cliente. Llama a Helpium.identify() después de que se complete la autenticación.