Skip to main content
< Back
Print

Initial Connection & Authentication

Set Up Your Shopware API Key

First up, you will have to create your API Key and add it as a Contentserv Credential. To create your Shopware API Key, you need to go to your Shopware system and head to your Settings Tab, there you will have to go to the Integrations Settings.

There is an option to create Integrations via Users & Permissions, however this option is deprecated and not recommended by Shopware. For this reason we will not explain this any further.

Now you are at the right spot, to create your API Key click on Add integration. Here you will be prompted to give your API Key a Name/Label and a Role or, if needed, Administrator rights.

We’d like to point out, as Shopware itself states, please note your Secret access key after saving this API Key/Integration, as it will no longer be available. Also save your Access key ID somewhere, because we will use it in the next step.

Add API Key as a Contentserv Credential

After getting our API Key from Shopware we will now have to implement this Key within Contentserv to access it in the SAWS Connector. To add your API Key, go to the Settings tab, after that click on Credentials. To add a new Credential click on the + in the Top Left Corner. After clicking the + Symbol a new window will appear to the right to add the new Credential. For the Credential, add a Name, the Token which is your Access Key ID and the Module the Credential is for, here just select SAWSConnector (sawsconnector), feel free to add a Label and/or a Description although it is not needed. Once you are finished setting up your Credential, press the Save button in the Top Left of the Credential Window.

After clicking on the Save button a window will appear prompting you to verify your password, with that the Token is meant, so just re-enter the Token and press OK. If the Credential is not appearing, just press the Save button again and it should appear as a new Credential.

Authorize Your Shopware Station

To finalize your connection to your Shopware System, you will need to create a Shopware Station. If you are unsure how to do that, follow How to add a Shopware Station. If you already have one, add the Authentication Key to that Station. To authorize a Station, click on the Shopware Station you want to connect and head to the Target System/Format tab. Now there are some things for you to configure:

  • URL to the API of the Shopware 6 target system
  • Username
  • Password, which is the Credential we just created.
  • Check the Use Integration Access Key checkbox.

After filling out these necessary things, go ahead and click Save. After that you can check the connection with the Check Connection button, which we recommend.

How to add a Shopware Station

To add a Shopware Station, you will need to click on your Station List located in the top left corner.

Next, you will need to click on the Add / Edit Station button next to it.

After that, you will need to select your Shopware Connector. In our case, we will use the Shopware 6 Connector.

After selecting your Connector, you will need to add a Station. To do so, click on + Add New Station in the top right corner.

Now you will need to give your new Station a Name and select a Color. After this, press Save. You have now successfully created a new Shopware Station.

Was this article helpful?
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents