Skip to main content

Getting Started

This guide will help you install and set up the NextGen OpenAI Chatbot plugin for your Shopware 6 store.

Prerequisites​

Before installing the plugin, make sure you have:

1. OpenAI API Access​

  • An active OpenAI account
  • API key with billing enabled
  • Important: A ChatGPT Plus or Pro subscription is NOT sufficient - you need API credits

2. System Requirements​

  • Shopware 6.6.3 or higher
  • PHP 8.1 or higher
  • Active internet connection for API calls

3. Required Dependencies​

  • OpenAI Assistant Manager plugin (will be installed automatically)

Installation Steps​

Step 1: Install the Plugin​

  1. Via Shopware Admin Panel:

    • Go to Extensions > My Extensions
    • Search for "NextGen OpenAI Chatbot"
    • Click "Install"

  2. Via Command Line:

    composer require fel-oai-chatbot/fel-oai-chatbot
    bin/console plugin:install FelOaiChatbot
    bin/console plugin:activate FelOaiChatbot

Step 2: Configure OpenAI API​

  1. Get Your OpenAI API Key:

    • Visit OpenAI Platform
    • Navigate to API Keys section
    • Create a new secret key
    • Copy the key securely

  2. Add API Credits:

    • Go to Billing in your OpenAI account
    • Add credits to your account
    • Minimum recommended: $10 for testing

Step 3: Set Up OpenAI Assistant​

  1. Create an Assistant:

    • Go to OpenAI Platform > Assistants
    • Create a new assistant
    • Configure it with appropriate instructions
    • Note down the Assistant ID

  2. Configure Tools (Recommended):

    • Enable function calling
    • Add relevant tools for product search
    • Configure knowledge base access

Step 4: Configure the Plugin​

  1. Navigate to Plugin Settings:

    • Go to Extensions > My Extensions
    • Find "NextGen OpenAI Chatbot"
    • Click "Configure"

  2. Basic Configuration:

    • Enable Plugin: Check the box to activate
    • OpenAI API Key: Paste your secret API key
    • Assistant ID: Enter your OpenAI Assistant ID
    • Chatbot Name: Give your chatbot a friendly name

  3. Test the Connection:

    • Use the "Test API Key" button to verify connection
    • Ensure the test is successful before proceeding

Initial Setup Complete​

Once you've completed these steps:

  1. Clear Cache:

    bin/console cache:clear

  2. Visit Your Storefront:

    • The chatbot should now appear on your store
    • Look for the chat icon (usually bottom-right)

  3. Test Basic Functionality:

    • Click the chat icon
    • Try asking "How can you help me?"
    • Verify responses are working

Next Steps​

Common Installation Issues​

Plugin Not Appearing​

  • Verify Shopware version compatibility
  • Check if all dependencies are installed
  • Clear cache and rebuild

API Connection Failed​

  • Verify API key is correct
  • Check if billing is enabled on OpenAI account
  • Ensure internet connectivity

Assistant Not Responding​

  • Verify Assistant ID is correct
  • Check if Assistant is properly configured
  • Review OpenAI usage limits

For more detailed troubleshooting, see our Troubleshooting Guide.

Need Help? Contact our support team at 5-elements-web.de or check our FAQ.