Quickstart
Embed de widget en verkrijg een widget token van de server.
Widget Overzicht
De widget-app wordt gehost op widget.companin.tech en biedt een eenvoudige manier om een AI-assistent in te sluiten in uw website. Om te beginnen, moet u een assistent en een OAuth-toepassing maken.
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. Een Assistent Maken
Maak eerst een AI-assistent in uw dashboard:
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.
- Ga naar uw dashboard en navigeer naar de "Data Sources"-pagina
- Klik de "Add"-knop in de Assistants-sectie
- Vul de assistentdetails in (naam, beschrijving, toon, etc.)
- Sla de assistent op en noteer de 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. Een OAuth-Toepassing Maken
Maak een OAuth-toepassing om uw widget te authenticeren:
- Ga naar de "OAuth"-pagina in uw dashboard
- Klik "Create Application"
- Vul de toepassingsnaam en beschrijving in
- Kopieer de
client_iduit de gemaakte toepassing
3. De Widget Insluiten via Iframe
De eenvoudigste manier om de widget te integreren is door deze direct in te sluiten met behulp van een iframe. Deze methode vereist geen JavaScript-initialisatie en werkt direct.
<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>Vervang YOUR_CLIENT_ID en YOUR_ASSISTANT_ID door uw werkelijke waarden. De locale-parameter kan worden ingesteld om overeen te komen met de taal van uw site.
Geavanceerd: JavaScript Initialisatie
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
Notes
- 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