Topdata Topdata Docs

TopdataConnectorSW6

About

TopCONNECTOR - Data Interface

“TopCONNECTOR” enables convenient connection to our web service and thus serves as the central hub for using all plugins that are based on our product data.

Installation

Introduction

In our manual, we show you step by step how to install and set up the plugin. Despite extensive software testing, minor bugs may still occur in different Shopware environments. We handle such bugfixes quickly and efficiently, usually on the same day.

Support

If you encounter any problems or have questions while setting up your “TopCONNECTOR”, please contact us at: shopware@topdata.de.

Important Notice

Each installation or update of a plugin in your Shopware shop represents a change to the software. Despite all quality assurance measures carried out by us or Shopware, we cannot rule out the possibility that problems may occur during installation or updates in exceptional cases.

Therefore, we generally recommend:

  • Testing new plugins or updates of already installed plugins in a suitable test environment first
  • Not deploying them directly to the live environment
  • Regular backup of your live environment is also strongly recommended

System Requirements

  • Linux-based operating system with Apache 2.2 or 2.4
  • Web server with mod_rewrite module and ability to access .htaccess
  • PHP 7.2.x / 7.3.x (7.2.20 and 7.3.7 are not compatible)
  • MySQL >= 5.7 (except 8.0.20 and 8.0.21)
  • Ability to set up cron jobs
  • At least 4 GB of free disk space
  • Shell access is required to start the import
  • Recommended: memory_limit > 512M

Setting up your “TopCONNECTOR” Step by Step

  1. Download “TopCONNECTOR” for free from the Shopware Community Store
  2. Please complete the ordering process by adding “TopCONNECTOR” to your cart and completing the checkout process
  3. Download “TopCONNECTOR” in the admin area of your Shopware shop under the “Purchases” menu item and then install the plugin under “My Plugins”
  4. In the next step, activate your “TopCONNECTOR”
  5. Finally, configure your “TopCONNECTOR” according to your preferences

Webservice Credentials

After installing the plugin, you need to fill in API credentials to connect to TopData Webservice.

Settings - System - Plugins - TopdataConnector menu (
 on the right) - Config

TopData provides you with:

  • API User-ID
  • API Password
  • API Security Key

Demo Credentials

If you want to test the plugin with demo credentials, you can use the following:

  • API User-ID: 6
  • API Password: nTI9kbsniVWT13Ns
  • API Security Key: oateouq974fpby5t6ldf8glzo85mr9t6aebozrox

Automated Import via Scheduled Task

The plugin provides a scheduled task (topdata.connector_import_task) for daily automatic imports. By default, this is disabled to prevent unexpected server load.

Enabling the Scheduled Import

To activate the automatic daily import:

  1. Log in to the Shopware Administration.
  2. Go to Extensions > My extensions.
  3. Open the configuration for the Topdata Connector plugin.
  4. Toggle Enable Automatic Scheduled Import to active and save.

Required runtime processes

Shopware requires background workers for scheduled tasks to function:

  1. Scheduler process (triggers due tasks): bin/console scheduled-task:run
  2. Messenger consumer (executes task handlers): bin/console messenger:consume async

For immediate manual execution, use: bin/console topdata:connector:import --all

Settings of your “TopCONNECTOR”

Configure “TopCONNECTOR” according to your needs:

  1. Sales Channels
    Select which sales channels the settings should apply to

  2. API User ID
    Enter the API User ID provided by us

  3. API Password
    Enter the API Password provided by us

  4. API Security Key
    Enter the API Security Key provided by us

  5. API Language
    Select your preferred language

  6. Check Connection
    Verify the connection to the web service

  7. Please select your Product Mapping Variant
    Decide how your articles should be linked to our product database

  8. OEM Field
    Enter the name of your designated OEM properties/additional field

  9. EAN Field
    Enter the name of your designated EAN properties/additional field

  10. Supplier Article Number Field
    Enter the name of your designated supplier article number properties/additional field

What is the purpose of “TopCONNECTOR”?

“TopCONNECTOR” is the core component of our data plugins and ensures the connection between your Shopware shop and our web service. For the functionality of our data plugins, the prior installation of “TopCONNECTOR” is mandatory.

Is a TopData membership required for “TopCONNECTOR”?

No, the use of “TopCONNECTOR” is free of charge. The plugin is available for you in the Shopware Community Store.

Demo Installation of “TopCONNECTOR”

You can install a demo version of “TopCONNECTOR” to test our data plugins.

Download the desired plugins and “TopCONNECTOR” for free from the Shopware Community Store

Install “TopCONNECTOR” and the desired plugins according to our installation guide

Set up “TopCONNECTOR” with the following demo credentials:

  • API User ID: 6
  • API Password: nTI9kbsniVWT13Ns
  • API Security Key: oateouq974fpby5t6ldf8glzo85mr9t6aebozrox

Select the mapping option in “TopCONNECTOR”: “Standard OEM EAN”

The use of the data plugins requires that the following printers and/or their consumables with stored EAN and/or OEM number are present in your shop:

  • HP Deskjet 1000 (CH340B)
  • HP Deskjet 1055
  • HP Deskjet 2000 (CH390A)
  • HP Deskjet 2544 AIO (D3A78B)
  • HP ENVY 4506
  • Samsung CLP 360 (CLP-360/SEE)
  • Samsung CLX 3300
  • Samsung Xpress SL-C 410 W
  • Samsung Xpress C 460 W (SL-C460W/SEE)
  • Canon Pixma IP 3100
  • Epson Stylus SX 438 W (C11CB21305)