Inicio Rápido
Integra el widget y obtén un token de widget del servidor.
Resumen del Widget
La aplicación widget está alojada en widget.companin.tech y proporciona una forma fácil de incrustar un asistente de IA en su sitio web. Para comenzar, necesitará crear un asistente y una aplicación OAuth.
The widget is a lightweight, self-contained application that runs in an isolated iframe on your website. This architecture ensures that the widget won't conflict with your existing CSS or JavaScript, while maintaining excellent performance and security.
⚡ Quick Deployment
Most developers have the widget running on their site within 10 minutes. The setup process involves just three steps: creating credentials, configuring appearance, and adding a single script tag to your HTML.
1. Crear un Asistente
Primero, cree un asistente de IA en su panel de control:
Your assistant is the AI brain behind the widget. It processes user messages, maintains conversation context, and generates intelligent responses. Each assistant can be customized with specific instructions, personality traits, and knowledge bases to match your use case.
- Vaya a su panel de control y navegue a la página "Data Sources"
- Haga clic en el botón "Add" en la sección Assistants
- Complete los detalles del asistente (nombre, descripción, tono, etc.)
- Guarde el asistente y anote su ID
Tip: Give your assistant clear, specific instructions about its role and limitations. For example: "You are a helpful customer support assistant for a SaaS product. You can answer questions about features, pricing, and account management. For technical issues, direct users to create a support ticket."
2. Crear una Aplicación OAuth
Cree una aplicación OAuth para autenticar su widget:
- Vaya a la página "OAuth" en su panel de control
- Haga clic en "Create Application"
- Complete el nombre y la descripción de la aplicación
- Copie el
client_idde la aplicación creada
3. Incrustar el Widget vía Iframe
La forma más simple de integrar el widget es incrustarlo directamente usando un iframe. Este método no requiere inicialización de JavaScript y funciona de inmediato.
<iframe src="https://widget.companin.tech/embed/session?clientId=YOUR_CLIENT_ID&assistantId=YOUR_ASSISTANT_ID&configId=YOUR_CONFIG_ID&locale=en" style="border: none; position: fixed; bottom: 20px; right: 20px; z-index: 999999; background-color: transparent; width: auto; height: auto; border-radius: 8px;" title="AI Assistant Widget"></iframe>Reemplace YOUR_CLIENT_ID y YOUR_ASSISTANT_ID con sus valores reales. El parámetro locale se puede configurar para que coincida con el idioma de su sitio.
Avanzado: Inicialización de JavaScript
The recommended integration method is using our JavaScript widget loader, which provides automatic sizing, configuration management, and responsive behavior.
Script Integration
Add the following script tag to your HTML page:
<script src="https://widget.companin.tech/widget.js" data-client-id="YOUR_CLIENT_ID" data-assistant-id="YOUR_ASSISTANT_ID" data-config-id="YOUR_CONFIG_ID" data-locale="en" data-dev="false"></script>Script Attributes
Each attribute serves a specific purpose in configuring your widget:
data-client-id: Your OAuth client ID - This authenticates your application with our API. Think of it as your app's password.data-assistant-id: The UUID of your assistant - This identifies which AI assistant handles the conversations.data-config-id: The UUID of your widget configuration - This determines how your widget looks and behaves (colors, size, position, etc.).data-locale: Language code (e.g., "en", "es", "fr") - Sets the widget's display language. The assistant will still respond in any language users write in.data-dev: Set to "true" for development mode (localhost) - Use this when testing locally. Remove or set to "false" for production.
The widget will automatically:
- Fetch the configuration from the config ID
- Size itself according to the widget dimensions in the config
- Position the collapsed button based on the config settings
- Start open or closed based on the config's
start_opensetting
Notas
- The widget automatically manages its own sizing based on your configuration settings
- The collapsed button position can be customized through the widget configuration
- The widget respects the
start_opensetting from your configuration - All styling (colors, fonts, dimensions) is controlled through the widget configuration
- The widget uses postMessage communication for responsive behavior
- Development mode can be enabled with
data-dev="true"for localhost testing