Add your application by wizard
You can add your application via the integration wizard, you can find the button for this on the dashboard page.
After clicking the start integrating button a pop up will appear with the wizard, please make sure you do not use any pop-up blocker at this point.
Click next and in the following screen you can add your applications that you want to connect. Search for Shopware and click on the Application.
For Shopware the following fields need to be filled out for a successful connection to be established.
- Display Title: The name of the application, no special requirements.
- This can be useful if there are multiple Shopware applications, to be able to distinguish between them.
- Client ID: This is the Access key ID in Shopware.
- Check the section below on how to find this parameter.
- Client Secret: This is the Secure acces key in Shopware.
- Check the section below on how to find this parameter.
- API URL: This is the web-address (URL) of the Shopware installation for this application.
- Usually this is the address of the webshop. Example: “mywebshop.com”
NOTE: you need to enter the URL of the sales channel you'd like to connect.
You can find this with clicking on the 'eye' behind the sales channel
- Usually this is the address of the webshop. Example: “mywebshop.com”
- API version:
When you run Shopware 6.3: enter v3
from Shopware 6.4 this field is not required
Shopware settings location
Client ID and Client Secret
To find these parameters, a Webservice App must be available or created, please follow the next few steps.
Login to the Shopware portal and open the Settings section.
Select the system settings, and navigate "users & permissions"
Create a new administrator user account for the API connection. You can use an existing user account, however it is advised to use a different user for the API.
Create a new Access Key, be sure to save the keys shown.
Copy the Access key ID and Secret acces key. Paste them in APIcenter.
Save the acces keys in Shopware.
NOTE:
Client ID: This is the Access key ID in Shopware.
Client Secret: This is the Secure acces key in Shopware.
API url
Copy the url of your Shopware installation. This is the public Shopware URL, so NOT the admin URL. For instance my-testdomain.com/public
Note: leave the "https://" and the "/" on the end.
Finalization:
When settings are filled out, the result installation form should look something like this.
Now you have succesfully added the Shopware application, you need to enter the second application, which you would like to set up the integration with Shopware with. See the Application Manuals page on how to setup the second application you want to use.
In step 3 you can select the packages that you want to make use of. These packages are the flows that determine what data is send from and to Shopware.
In step 4 you can set the all the settings that tweaks your integration without adjusting mappings and or adjusting code. In this step you need to do this for all your flows. The settings we have standard enabled and disabled are based upon 90% of the integrations we currently have running.
Step 5 finishes the wizard and on this point you can enable the flows to start running, if you want to adjust advanced settings we advice to start them manually in the integrations overview.