| REQUIRED USER ROLE Administrator | PERMISSION OVERVIEW View permissions by role |
Before you start
Review the following information before you connect Magento to Gladly.
Magento integrates with Gladly via the Lookup Adaptor.
Gladly supports Magento version 2.x.
Make sure you have administrator access to your Magento account. This is required to connect Magento to Gladly.
You must configure Magento first before connecting it to Gladly.
Configure Gladly integration in Magento
Set up Magento by following the instructions below.
Log into Magento as an Administrator.
Go to Systems > Integrations to create a new integration with Gladly.
Click Add New Integration.
From the New Integration page, in the Integration tab, enter the following information:
Name – Enter a name that helps you identify this integration.
Email – Not required.
Callback URL – Not required.
Identify link URL – Not required.
Your Password – Enter your Magento account password for verification.
Click Save & Activate.
Next, on the left side of the screen, click API. From the Resource Access dropdown list, select All, then click Save & Activate.
From the fly-out menu that then appears, click Allow.
Your OAuth consumer key/secret and token key/secret will be generated and displayed once the integration is created.
You can find these again by clicking Edit on the integration and scrolling down.
Next, you must deactivate the CSRF token. By default in Magento 2, a unique CSRF token is generated and appended onto the URL of every page. This makes your site more secure, however, the Gladly platform cannot generate valid hyperlinks to your store if this token is activated. This means that links to Customer Profiles and order pages will not resolve. Click Stores in the menu, and click Configuration.
Scroll down towards the bottom and go to Advanced > Admin.
Find “Add Secret Key to URLs,” uncheck “Use system value,” and select “No.” Then click Save Config.
Next, proceed to set up Magento in Gladly.
Connect Magento to Gladly
From the Apps page, click Add App > Magento.
From the Add New Magento App page, enter the following information:
Name – Enter a name that will help you identify the Magento instance.
Magento Base URL – Enter the base URL to your Magento store without any paths. For example, https://www.retale.com, not https://www.retale.com/admin.
Magento Deep Link URL (optional) – Specify the path for your admin interface if it differs from the base URL. For example, https://www.retale.com/admin.
Consumer Key – Found in Magento.
Consumer Secret – Found in Magento.
Access Token – Found in Magento.
Access Token Secret – Found in Magento.
Search Query Attributes – There are two columns (Attribute, Label) required for Search Query Attributes. The email/Email attribute is the only attribute you can use.
Don't delete the email attribute. Doing so will break your lookup search capability.
Don't change the Attribute column.
Currently, only exact search by email is supported to query Magento for matching Profiles
Search Results Attributes – There are two columns (Attribute, Label) required for Search Results Attributes. The name/Name, email/Email, externalCustomerId/Magento ID attributes are the default attributes. Click Add an attribute to add a new attribute.
We recommend not deleting the email attribute – Email makes it easier to verify search results.
Auto-Linking Fields – If a Customer Profile is not currently linked to a Magento instance and if your Magento instance responds with a unique profile with at least one auto-linking field match and no conflicts, Gladly will automatically link the profiles without any user intervention and populate the pulled information in the Customer Profile.
Customer Email – Check this box to activate auto-linking by matching email addresses.
Phone Number – Check this box to activate auto-linking by matching phone numbers.
Overwrite Existing Values – If activated, and a Customer Profile is linked to a profile in Magento, Gladly will overwrite the existing name, address, and editable custom attributes in the Customer Profile with data from Magento.
Click Save App when you're done. If the required fields are not completed, an error will appear; they are highlighted in red. Complete the missing fields and click Save App again.
List of Search Results Attributes
Magento allows a specific set of attributes to be pulled and displayed in Gladly.
For the Attribute column, you can use:
name
email
externalCustomerId
address
You can use any Label for each attribute that provides an Agent-friendly name for the attribute. For example, externalCustomerID can be labeled as Magento ID.
Click 
to delete an attribute.
If you use an attribute not listed above, the column still appears for Agents but will not be populated with any information.