Hurtigstart

Widget Oversikt

Widget-appen er hostet på widget.companin.tech og gir en enkel måte å bygge inn en AI-assistent på nettstedet ditt. For å komme i gang må du opprette en assistent og en OAuth-applikasjon.

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.

1. Opprett en Assistent

Først, opprett en AI-assistent i dashbordet ditt:

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.

1. Gå til dashbordet ditt og naviger til "Data Sources"-siden
2. Klikk "Add"-knappen i Assistants-seksjonen
3. Fyll inn assistentdetaljene (navn, beskrivelse, tone, etc.)
4. Lagre assistenten og noter ID-en

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. Opprett en OAuth-Applikasjon

Opprett en OAuth-applikasjon for å autentisere widgeten din:

1. Gå til "OAuth"-siden i dashbordet ditt
2. Klikk "Create Application"
3. Fyll inn applikasjonsnavn og beskrivelse
4. Kopier client_id fra den opprettede applikasjonen

3. Bygg inn Widgeten via Iframe

Den enkleste måten å integrere widgeten på er å bygge den inn direkte ved å bruke en iframe. Denne metoden krever ingen JavaScript-initialisering og fungerer ut av boksen.

<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>

Erstatt YOUR_CLIENT_ID og YOUR_ASSISTANT_ID med de faktiske verdiene dine. locale-parameteren kan settes til å matche nettstedets språk.

Avansert: JavaScript-Initialisering

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_open setting

Notater

• 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_open setting 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