The integration instructions are for Magento Enterprise, and Magento Community Edition. ShopSocially tag can be easily integrated with a Magento store (Enterprise and Community Edition). With this, you can activate ShopSocially Apps on your Magento store and start running campaigns in matter of minutes.


You can download ShopSocially Magento plugin at ShopSocially Magento.


Setup instructions for installing ShopSocially cartridge on Magento store


It is recommended that:

1. You take complete backup of your Magento store.

2. You install the plugin on your Test Server first. You should test the installation on your Test Server, and then install the plugin on your Production Server.


Steps to integrate ShopSocially into Magento store are given in sections below. Please follow the steps in the same order, section wise.


1. Installing ShopSocially plugin

2. Enabling ShopSocially Apps

3. Enabling Loyalty App

4. Enabling Customer Q & A

5. Enabling Social Login


1. Installing ShopSocially plugin


To install ShopSocially plugin, please follow steps given below:


1. Log into your Magento Store Admin Panel.

2. Navigate to System > Tools > Compilation menu. Please disable compilation if it is enabled. Refer to Figure: Magento Admin Panel.


Figure: Magento Admin


3. Login to Magento Connect Manager with Admin credentials.

4. In Settings, clear the check box for Put store on the maintenance mode while installing/upgrading/backup creation.

5. In 'Direct Package file' tab, choose file to upload, and click Upload. The package will be automatically installed. Refer to Figure: Magento Connect Manager.


Figure: Magento Connect Manager


6. Log out of Magento Admin and login again.
7. Go to System > Tools > Compilation tab, and enable compilation. If the plugin is installed correctly you should be able to see ShopSocially. To see the ShopSocially tab, in System, click Configuration. The ShopSocially tab will then be shown on in the menu on the left side. Please refer to Figure: ShopSocially Tab 1.

Figure: ShopSocially Tab 1


Please note: If you are able to see ShopSocially tab in the menu on the left side, then the plugin is successfully installed on your website.

2. Enabling ShopSocially Apps

To enable ShopSocially Apps, please follow the steps given below:

1. Click on ShopSocially tab on menu on left side. Refer to Figure: ShopSocially Tab 2.

Figure: ShopSocially Tab 2


2. In Enable ShopSocially, select Yes from drop down. Refer to Figure: Enable ShopSocially.

Figure: Enable ShopSocially


3. Enter ShopSocially Partner ID, and ShopSocially API Key. Refer to Figure: ShopSocially API Key.

Figure: ShopSocially API Key


Please note: Your ShopSocially Partner ID, and ShopSocially API Key can be found in your ShopSocially Admin Console, under Settings > Basic > General Information. Please refer to Figure: ShopSocially Partner ID.

Figure: ShopSocially Partner ID


4. Advanced Integration: For us to track sales and for running Post Purchase Apps, it is necessary to Enable Advanced Integration. To do this, in ShopSocially tab, in Enable Advanced Integration, select Yes from drop down. Refer to Figure: Advanced Integration.

Figure: Advanced Integration


3. Enabling Loyalty App

To enable Loyalty App, please follow the steps given below:

1. Click ShopSocially tab.
2. In Enable Loyalty, select Yes from drop down. URLs for below mentioned will be generated automatically. 

  • Loyalty Authentication URL 
  • Loyalty User Dashboard URL 
  • Loyalty User Endpoint URL

However due to certain customizations in Magento, the URLs may not be exact URLs. To verify the URLs, copy and paste the Loyalty Authentication URL in your browser. If you are taken to the login page, then the URLs generated are exact URLs. If you are not taken to the login page, then below mentioned are the URL formats:

  • Loyalty Authentication URL: <your store URL>/customer/account/login/?loyalty-dashboard=true 
  • Loyalty User Dashboard URL: <your store URL>/shopsocially/loyalty/loyaltydashboard 
  • Loyalty User Endpoint URL: <your store URL>/shopsocially/loyalty/endpoint

Please use the above format to create URLs, and paste those URLs in ShopSocially Merchant Centre Console, as mentioned in the subtext below those URLs in the Magento Admin Panel. Refer to Figure: Enable Loyalty.

Figure: Enable Loyalty


To paste those URLs in ShopSocially Merchant Centre Console, follow steps given below:

1. In ShopSocially Merchant Centre Console, click Loyalty tab, and then click Dashboard Config.
2. In Authentication Options, in Authentication Type, select Token Based Authentication from drop down.
Please note: To use the ShopSocially plugin, it is mandatory to select Token Based Authentication.
3. In Loyalty Authentication URL, paste the Loyalty Authentication URL. Refer to Figure: Loyalty Authentication URL.

Figure: Loyalty Authentication URL


4. In Loyalty Dashboard, paste the Loyalty User Dashboard URL. Refer to Figure: Loyalty User Dashboard URL.
 

Figure: Loyalty User Dashboard URL

5. In Authentication Options, in User Endpoint, paste the Loyalty User Endpoint URL. Refer to Figure: Loyalty User Endpoint URL.

Figure: Loyalty User Endpoint URL

6. Click Save.
Please note: Alternatively you can contact ShopSocially Customer Success Manager (CSM), and respective CSM can help you.
3. Please provide the link for Loyalty User Dashboard prominently on your Magento store. You will need to do this, as the plugin does not do it automatically. This will help the users to easily access their Loyalty User Dashboard, when users login to their account on your website. Please refer to Figure: My Dashboard 1, and Figure: My Dashboard 2, for examples.

Figure: My Dashboard 1


Figure: My Dashboard 2


4. Enabling Customer Q & A

To enable Customer Q & A App, please follow the steps given below:

1. In ShopSocially tab, in Enable Customer Q and A, select Yes from drop down.

2. In Auto-insert Customer Q and A div, select Yes from drop down.


When you select Yes, in Enable Customer Q and A, the  Customer Q & A App will be shown above the footer on all product pages.

Please refer to Figure: Enable Customer Q and A.

Figure: Enable Customer Q and A


Please note: If you select No, in Enable Customer Q and A, you will need to put the below code at the place where you want Customer Q and A App to appear:
 

<div id="ss_qna_div"></div>

5. Enabling Social Login


To enable Social Login App, please follow the steps given below:


1. In ShopSocially tab, in Enable Social Login, select Yes from drop down.

2. In Auto-insert Social Login div, select Yes from drop down.


When you select Yes, in Enable Social Login, the Social Login App will be shown on the Login page. Please refer to Figure: Enable Social Login.


Figure: Enable Social Login


Please note: Social Login is not setup on the checkout page by default. You will need to add the code mentioned below to enable it. If you select No, in Enable Social Login, even then you will need to put the below code at the place where you want the Social Login buttons to appear:


<div style="position: absolute; z-index: 5; bottom: 0px; text-align: center; top: -177px; width: 100%; background-color: rgba(0, 0, 0, 0.7); height: 209%; left: -2px; display:none;" id="loginProcess"><center><img src="//dgjcoqnzn763b.cloudfront.net/images/general/loader.gif" style="margin-top:22%;" alt="Loading....."></center></div>


<div id="ssmi_social_login_div" style="margin: 0 auto;"></div>