Magento

About APSIS One's Magento Integration

"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.

 

Expand an item below to learn more about the APSIS One Magento integration.

APSIS One's Magento Integration

About APSIS One's Magento Integration

APSIS One's Magento Integration allows for a full sync between Magento and your APSIS One Audience. Synchronise Magento's customer data into Profiles and populate them with their behavioural events as well as informative sales data.

To read more about the data fed into APSIS One Profiles from your Magento integration, take a look at this article.

Prerequisites

Magento Prerequisites

The APSIS One Magento module is compatible with both Community and Enterprise platforms of Magento.

Make sure you've installed one of the following Magento versions:

  • For Community, we're compatible with version 2.2.0 and above.
  • For Enterprise, we're compatible with version 2.2.0 and above.

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

Solution Overview

Module File Location

The Magento module installs files in one of the following locations, depending on the installation method:

For an FTP / GIT installation:

MAGENTO_ROOT/app/code

 

For a Composer installation:

MAGENTO_ROOT/vendor

 

Database Tables

The module creates the following tables in Magento's Database:

apsis_abandoned
apsis_event
apsis_profile
apsis_profile_batch

 

The module will copy data related to historical Magento subscribers and customers to:

apsis_profile table

 

Magento Admin Panel

The module creates the following resources in Magento's admin panel:

Reports > Apsis One > Apsis Profile
Reports > Apsis One > Apsis Event
Reports > Apsis One > Apsis Abandoned Basket
Stores > Settings > Configuration > Apsis Configuration

 

Cron tasks

Magento performs operations on schedule (Cron) by periodically running a script.

The connector module has several cron tasks attached with the installation to ensure that the connector functions correctly. Below is a list of current tasks and their timings:

Tasks with 5 minute intervals:

apsis_one_sync_profiles
apsis_one_find_abandoned_carts
apsis_one_sync_events

 

Task with 30 day intervals by default, can be adjusted in the connector's configuration:

apsis_one_cleanup

 

Enabling Magento in APSIS One

Enabling Magento in APSIS One

1. Head over to Account Settings in APSIS One.

magento1.jpg

 

2. Select a Section and open the Integrations tab.

If you have multiple stores, we recommend that you create a separate Section for each one of them, and follow the instructions described below in Initial Connector Setup below.

integrations1.jpg

 

3. Locate Magento and click Connect.

magento2.jpg

 

4. A Client ID and a Secret Key will be created.

Copy your Client ID and Secret Key and save them. You will need this information to proceed with setting up your Magento integration. Once you close this window, the Secret Key will no longer be available.

magento3.jpg

 

Before you Begin

Before installing the Magento Connector Module

To perform the Magento Connector installation, you must have an Administrator role in Magento.

The module installation requires user access to file server and expertise in running commands in the Linux Bash terminal: we strongly recommend that this is done by a developer.

Please ensure that the file server user has permissions to execute commands and is able to transfer files.

After installing the Magento Connector, follow the steps described under Initial Connector Setup.

 

Do you have multiple stores or websites?

The module supports multiple stores. If you are running multiple stores within the same Magento account, we recommend that you link one store to one Section in APSIS One. If you are configuring multiple sites to multiple Sections, you'll need to follow the entire process for each separate store you have.

Module Installation

Module Installation

The installation of the Magento module can be done via FTP, GIT, or Composer.

Regardless of your Magento version, the installation process is the same.

Click an item below to expand each section on how to install the Magento Module for each method.

FTP Installation

 Plan your installation carefully.

In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again. Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

 

1. Download the files to the connector from GitHub, located at:

 Coming soon...

 

2. Download as a ZIP and unzip the file.

3. Create the directory structure in Magento at:

Magento_Root/app/code/APSIS/One

 

4. Drop all the content inside the unzipped folder to the following directory:

Magento_Root/app/code/APSIS/One

 

5. Run the following command in the Magento root:

php bin/magento module:enable Apsis_One

 

6. Then run:

php bin-magento setup:upgrade

 

7. If you have a single website and store, run the following command in the Magento root:

php bin/magento setup:di:compile

 

Otherwise, if you have multiple websites and stores, run:

php bin/magento setup:di:compile multi-tenant

 

8. Clear the cache. All set!

To continue, follow the steps described below in Initial Connector Setup.  

GIT Installation

 Plan your installation carefully.

In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again. Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

 

1. Create the directory structure for GIT in Magento at:

Magento_Root/app/code/Apsis

 

2. Clone repository into the directory with the following command in the Magento root:

git clone URL_TO_GITHUB_REPOSITORY One

 

3. Run the following command in the Magento root:

php bin/magento module:enable Apsis_One

 

4. Then run:

php bin-magento setup:upgrade

 

5. If you have a single website and store, run:

php bin/magento setup:di:compile

 

Otherwise, if you have multiple websites and stores, run:

php bin/magento setup:di:compile-multi-tenant

 

6. Clear the cache. All set!

To continue, follow the steps described below in Initial Connector Setup.

Composer Installation

 Plan your installation carefully.

In a production environment, installation should be planned before continuing, as your site may be in maintenance mode until Magento is running again. Before installing Magento on APSIS One, we strongly recommend you to install and test the module on your staging server, and we strongly recommend that you backup your Magento databases and your website.

 

Note that the Composer Installation is only valid if the GitHub repository is public and published on Packagist.

1. Set up the correct path for Composer, or keep Composer within the Magento root.

2. Run the following command in the Magento root:

composer require apsis/module-one

 

3. Then run:

php bin/magento module:enable Apsis_One

 

4. Run:

php bin/magento setup:upgrade

 

5. If you have a single website and store, run the following command in the Magento root:

php bin/magento setup:di:compile

 

Otherwise, if you have multiple websites and stores, run:

php bin/magento setup:di:compile-multi-tenant

 

6. Clear the cache. All set!

To continue, follow the steps described below in Initial Connector Setup.

Initial Connector Setup

Initial Connector Setup

In order to proceed, the user's role must be set to Administrator. If the user's role is not Administrator, ensure that the user has access to the following resources:

Reports > Apsis One > Apsis Profile
Reports > Apsis One > Apsis Event
Reports > Apsis One > Apsis Abandoned Basket
Stores > Settings > Configuration > Apsis Configuration

 

1. Head over to Stores on the left side, inside Magento.

magento4.jpg

 

2. Click Configuration.

magento5.jpg

 

3. Choose the store you want to set up with APSIS One next to Store View,

If you have a single store in Magento, make sure Default Config is selected. Otherwise, select the store you want to set up.

If you are running multiple stores, we recommend that you link one store to one Section in APSIS One. This must be taken into consideration in this step and in the Data Mappings step described in the drop-down below.

Create a Section in your APSIS One account for each store you have in Magento.

Each Section has a unique Client ID and Secret Key.

When configuring your second or third stores, you will need to repeat this process with each one of them.

magento6.jpg

 

4.  Click Accounts under the APSIS One configuration menu.

magento7.jpg

 

5. In Enabled, select Yes from the drop-down menu. Two more fields will appear for you to complete.

magento8.jpg

 

6. In Client ID and Client Secret, enter the credentials created in APSIS One for the Section that corresponds with your store.

magento9.jpg

 

7. When done, click Save Config.

The module will validate the API credentials by generating a token that will confirm if the credentials are valid or not. If the credentials are not valid, contact your APSIS Account Manager.

Repeat this process to configure additional stores, using the Client ID and Secret Key generated for each corresponding Section.

magento10.jpg

 

Data Mappings

Data Mappings

In addition to the basic contact information, the Magento module allows you to map more than 50 sections of key retail information with your Section in your APSIS One account.

To set up your Data Mappings, head over to Magento's Admin panel and choose Data Mappings under the APSIS One drop-down menu.

magento12.jpg

 

1. Map your Section by expanding the drop down menu and selecting an item.

After mapping a Section, you will be able to map Attributes. The Email Attribute must be mapped in order to sync Profiles.

magento11.jpg

 

2. Click Save Config.

magento10.jpg

 

3. Expand the Attribute Mapping drop-downs to begin mapping.

There are three types of Attribute mappings:

Common Attributes are common to both Magento subscribers and customers.

Subscriber Attributes are exclusive to Magento subscribers.

Customer Attributes are exclusive to Magento customers.

magento13.jpg

 

4. Expand each drop-down menu and select an Attribute to map Magento's data with APSIS One Profiles.

magento225634.jpg

 

Consent List & Topics Sync

Consent List & Topics Sync

Sync your APSIS One Consent list and Topics with your Magento subscriptions at Profile Sync under the APSIS One drop-down, in your Admin panel.

magento16.jpg

 

1. Start by enabling the Subscriber Sync. Expand the Enabled drop-down and choose Enable.

magento15.jpg

 

2. Take a look at Consent List Topics and select the Topics you wish to sync with your Subscribers in Magento.

You must select at least one Topic for the Subscription sync to work. To select multiple Consent Lists and Topics, hold the Ctrl/Cmd key in your keyboard and click the items.

magento17.jpg

 

3. Click Save Config. That's it!

magento10.jpg

 

Reports

Reports

To view reports of the module's entities, click Reports on the left side menu.

magento18.jpg

 

The report will be available under the APSIS One heading. Here you will be able to see Profile Status, Registered Events, Abandoned Carts, and Log Viewer.

magento19.jpg

 

 


 

 

Was this article helpful?