Skip to main content
About the Magento Integration
Updated over a year ago

About the Magento Integration

Synchronise data from Magento to APSIS One - manage consent, sync customer data and create rich customer journeys with marketing automation. Read on to learn more about how the integration works!


In this Article


Full Sync & Real-Time Sync

There are two features that empower data transfer from Magento into APSIS One: Real-time Sync and Full Sync.

A Real-time sync takes place whenever a contact card is created or updated in Magento. This results in a corresponding Profile being updated or created in APSIS One, matching the state of the contact in the Magento.

A Full sync systematically goes through all contacts in your Magento account and either creates a new Profile in APSIS One, or updates the existing Profile data. We recommended using this feature after setting up your initial mappings, or when you intend to sync new mappings.

How Profiles are synced

When a Profile is created in APSIS One, it will receive the customer ID as a unique identifier, and Email and SMS consent is updated according to the chosen consent mapping. All data is written through Magento.

If a Real-time or Full sync detects a new email address for a Profile, the following will take place:

  1. The new email address will be opted-in to all Subscriptions which the old address had given consent to;

  2. The old email address will be opted-out from all Subscriptions and lose any consent, as it's no longer in use.


What can be Synced?

Consent

Sync the freely given consent stored on a Customer or Subscriber in Magento to a Profile in APSIS One. Without consent no communication can be send.

If a Customer or Subscriber in Magento decides to unsubscribe or a Magento user untick the consent box the corresponding Profile in APSIS One will also be opted-out. Read more about Consent Mapping.

Customer & Subscriber data

With easy data mapping you decide what data should be synced.

Sync data from a Customer or Subscriber in Magento to Profiles in APSIS One. By mapping data fields to Profile Attributes in APSIS One Profiles will be updated with data from Magento at all times. Read more about Field Mapping.

Historical data

Sync up to two years of the following historical data:

  • Customer/Subscriber Places an Order

  • Customer Adds A Product to Cart

  • Customer Leaves a Product Review

  • Customer Adds Product To Wishlist


Setting Up the Integration

Prerequisites

You will need an APSIS One Administrator role. We also recommend that the installation is performed by a developer.

If you are using an older version of the Magento integration, we recommend that you schedule an update immediately. Note that the older version of Magento are using old APSIS One endpoints that are deprecated and will soon be removed.

The current integration is also using outdated versions of Magento and PHP that is no longer supported by both Adobe and PHP

Software version needed for installing a connector version, please refer to the compatibility matrix below.

Connector version

Status

Magento versions

PHP

version

v2.0.7

released

Magento 2.2.x, 2.3.x, 2.4.0 - 2.4.3-p3

v7.1+

v2.0.8

released

Magento 2.2.x, 2.3.x, 2.4.0 - 2.4.3-p3

v7.1+

v2.1.0

released

v.3.0.0

November 2023

v2.4.1+

v8.1+

The integration is compatible with both Community and Enterprise platforms.

The cron heartbeat (Magento cron) should be running every minute to action the required tasks in the APSIS module.

IP Whitelisting

In order to successfully integrate with APSIS One your Magento deployment must be allowed to dial out to the below URLs.

EU

  • api.apsis.one

  • s3.eu-west-1.amazonaws.com

APAC

  • api-apac.apsis.one

  • s3.ap-southeast-1.amazonaws.com


How to integrate

Here's a summary of the process of integrating Magento with APSIS One. Click to jump right to a section in the article for a more detailed run-down.

Note: You need an APSIS One Administrator role to perform the Magento installation. We also recommend that the installation is performed by a developer.

1. Install the correct version of Magento.

2. Enable Magento.

3. Install the Magento module, either via Composer, FTP, or GIT.

4. Set up Magento Stores by pairing them with Sections in APSIS One.

5. Map the data from your Magento account with Attributes.

6. Sync Consent. APSIS One Subscription with Magento Subscriptions.

7. Sync historical Events from the Magento account.

Need a hand? One of our great Consultants can help you set up the integration and make sure all the right configurations have been made in Magento and APSIS One. Don't hesitate to reach out.


About Magento

"Magento is the leading platform for open commerce integration, handling over $100 billion in gross merchandise volume every year. Read more on Magento's website


What's Next?

Did this answer your question?