** This article covers Magento v2. For Magento v1, click here.**
The Magento connector makes it easy to get the core data for better marketing. Magento is a very flexible platform that allows people to make modifications to the core capabilities. The Zaius connector is built to integrate with Magento using best practices. If you have concerns with how your Magento store is setup, please reach out to email@example.com prior to integrating.
What Data is Integrated
|Web Site Data||No||Yes||
product page views
add to cart
remove from cart
How to Integrate Magento v2
Note: We have been revamping our Magento connector and are very close to release. Our latest release candidate has been successfully deployed in a number of environments, so if you and your team are ready for the latest-and-greatest, including a streamlined composer-based installation and more robust cart recovery functionality, you may wish to skip this guide and instead follow the one on Packagist.
To continue with the legacy connector including manual installation:
- Download the latest connector package: zaius_engage-magento2-2.3.1.tgz
- Install the connector on your Magento store.
# Copy zaius_engage_version to tmp dir.
docker cp zaius_engage-magento2-.tgz :/tmp/# Connect to Instance:
docker exec -it /bin/bashcd /tmp/
tar xzvf zaius_engage-magento2-2.3.0.tgz
rsync -voglrpt /tmp/app/ /var/www/html/app/rm /var/www/html/var/di
php -f bin/magento setup:upgrade
# Restart container (or service)
- Configure the connector within Magento
- Configure the connection to Zaius within Zaius
Congratulations! Your new events will now be sent to Zaius
Configure the Magento Connector
Once the connector is installed you can navigate to: Stores > Configuration > Zaius
You will need to add in your Tracking ID.
Magento 2.X Permissions Setup
The username and API key specified will be provided to Zaius in order to enable the integration.
This user must have permissions to use the Zaius Engage API to retrieve data from Magento. To ensure the user has appropriate permissions, navigate to System > User Roles > Add New Role.
Create a role (or extend an existing role) which has access to "Zaius Engage API".
Once the Role is created, make sure you associate the user with the new role.
Enter the username, API key and the URL endpoint on your server into the boxes found in the integrations screen in the Magento box.
The API URL is typically of the form: "http://your-magento-server"
Ensure that the version is set to Magento 2.
Do *not* use a URL like: "http://your-magento-server/api/v2_soap?wsdl=1" which won't work.