Difference between revisions of "X-Cart:Social Feeds"

From X-Cart 4 Classic
Jump to: navigation, search
(Created page with '==Overview== ===What Social Feeds does=== Connect with your customers and build a brand for the cost of some time and creativity. Promote your store and goods via Facebook, Twi…')
 
 
(23 intermediate revisions by 2 users not shown)
Line 15: Line 15:
 
==System requirements==
 
==System requirements==
  
−
To be able to successfully install and use the <u>Social Feeds</u> module, you must have a working copy of X-Cart GOLD / GOLD PLUS / PLATINUM version 4.6.0 or later installed on your server. Make sure that the version of the module is the same as the version of the installed copy of X-Cart.
+
To be able to successfully install and use the <u>Social Feeds</u> module, you must have a working copy of X-Cart GOLD / GOLD PLUS / PRO / PLATINUM version 4.4.0 or later installed on your server. Make sure that the version of the module is the same as the version of the installed copy of X-Cart.
  
 
{{Note1|'''Note:''' If you do not remember the version of installed X-Cart, find it in the Environment info section of the Summary page in X-Cart Admin area.}}
 
{{Note1|'''Note:''' If you do not remember the version of installed X-Cart, find it in the Environment info section of the Summary page in X-Cart Admin area.}}
Line 21: Line 21:
 
==Installation==
 
==Installation==
  
−
To install the module for X-Cart 4.6.0 or higher:
+
To install the module for X-Cart 4.4.0 or higher:
  
 
# Obtain a distribution package for the Social Feeds add-on module by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>social-feeds-x.y.z.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> are the version numbers of the module. Make sure the version of the module is the same as the version of the installed X-Cart.
 
# Obtain a distribution package for the Social Feeds add-on module by downloading it from the File Area section of your {{QA}}. The distribution package you need is contained in the archive file <u>social-feeds-x.y.z.tgz</u> where <u>x</u>, <u>y</u> and <u>z</u> are the version numbers of the module. Make sure the version of the module is the same as the version of the installed X-Cart.
Line 49: Line 49:
  
 
# In the <u>Modules</u> section (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the module name ('Social Feeds').<br />The module configuration page (titled by the name of the module) opens.
 
# In the <u>Modules</u> section (<u>Settings menu->Modules</u>), click the <u>Configure</u> link opposite the module name ('Social Feeds').<br />The module configuration page (titled by the name of the module) opens.
−
# Adjust the settings on the module configuration page.  Detailed information regarding the [[#AbandonedCartReminderConfigurationSettings | Abandoned Cart Reminder add-on module configuration settings]] is available below.
+
# Adjust the settings on the module configuration page.  Detailed information is available below.
 
# Click the '''Apply changes''' button to save the changes.
 
# Click the '''Apply changes''' button to save the changes.
−
{{Note1|'''Note:''' After the module is enabled the first time, it will work in manual mode and no automatic messages will be sent. You will need to[[#AbandonedCartReminderConfigurationSettings | set it up]] to work in fully automated mode}}
 
  
−
<div id="AbandonedCartReminderConfigurationSettings"> </div>
+
=== Configuring Facebook Feed ===
−
===Abandoned Cart Reminder add-on module configuration settings===
+
Simply add the address of your Facebook page and save the changes. Facebook feed will be automatically displayed in your store.:<br>
−
Here is an explanation of the Abandoned Cart Reminder add-on module configuration settings:
+
[[File:Facebook config.png| border]]
−
<br />
+
 
−
:* '''Handle sending out notifications manually or automatically?''' The mode in which you would like abandoned cart reminder email notifications to be sent. <br />''Manually'' corresponds to the mode in which abandoned cart notifications are not sent until you specifically instruct the module to send them. In this mode you yourself decide which users should be notified, when the notifications should be sent, with or without a coupon, etc.<br />''Automatically'' corresponds to the mode in which sending of abandoned cart notifications is initiated by a cron job. In this mode the number of times that a notification message should be sent, the time of sending the initial and subsequent notifications, whether the notification should include a discount coupon or not, etc are defined based on the add-on module configuration settings. Note that, if you choose the automated mode, you will need to make sure that the script for periodic tasks is properly set up in your store (See: [[X-Cart:Cron.php_-_Script_for_Periodic_Tasks | X-Cart:Cron.php - Script for Periodic Tasks]]).
+
=== Configuring Twitter Feed ===
−
<br />
+
You need to get your Twitter widget ID:
−
The following settings affect the work of the module only if the module is working in the automated mode:
+
 
−
:* '''After how many hours customer should be notified of abandoned cart''': The number of hours to wait after cart abandonment before sending an abandoned cart reminder notification to the cart owner.<br />{{Note1|'''Note:''' For stores sending multiple abandoned cart notifications about each abandoned cart this reflects the number of hours before the ''first'' notification is sent.}}
+
1. Login to Twitter using your account
−
:* '''How many notifications should be sent''': The number of reminder notifications that should be sent about each abandoned cart. The recommended value is 1. If you wish to notify the users about each abandoned cart more than once, you can specify a greater value here.<br />{{Note1|'''Note:''' Although it is possible to send multiple notifications, it is not recommended to do so, because customers may be annoyed by too many notifications and even mark them as spam.}}
+
 
−
:* '''Delay between notifications (in hours)''': (''This needs to be specified if you are going to send more than one notification about each abandoned cart.'') The length of period between reminder notifications being sent to the same user about a specific abandoned cart. Note that setting this value to "0" (zero) will result in that each user will be notified only once.<br /><br />''Example:''<br />If you use the following configuration:<br />[[File:Acr_conf_settings_ex1.png | border]]<br />abandoned cart owners will receive a reminder notification on the 6th, 18th and 30th hours after their abandoned cart has been registered by the module.<br /><br />
+
2. Go to https://twitter.com/settings/widgets/new
−
:* '''Type of discount coupon that should be attached to notifications''': If you want to offer a discount to the users whom you notify about an abandoned cart, you can specify what type of coupon it should be. Choose one of the following options:<br />''None'' -- no coupon will be attached to the notification;<br />''$ off'' --  a “flat amount off“ coupon will be attached to the notification;<br />''% off'' -- a “percentage amount off” coupon will be attached to the notification.<br /><br />
+
 
−
:* '''Discount coupon value''': This setting is related to the previous one; it allows you to specify the value of the discount given by the coupon.<br />Two examples below will clarify how it works.<br /><br />''Example 1.''<br />If you use the configuration below:<br />[[File:Acr_conf_settings_ex2.png | border]]<br />the coupon attached to the notification will give the user a 20$ discount off the purchase.<br /><br />''Example 2.''<br />If you use the following configuration:<br />[[File:Acr_conf_settings_ex3.png | border]]<br />the coupon attached to the notification will give the user a 10% discount.<br /><br />
+
3. You may leave all settings default and click on Create Widget button.
−
:* '''Period of abandoned cart expiration (Number of days after which email notifications to customer will no longer be sent and the coupon associated with the abandoned cart will become invalid)''': This setting defines when an abandoned cart as well as all the coupons associated with it should be deleted from the system.<br /><br />
+
 
 +
4. As a result a widget code will be generated. One of the parameters is named as <b>data-widget-id</b>. Alternatively widget ID can be taken from the URL address as soon as you generate it. It looks like:
 +
 
 +
https://twitter.com/settings/widgets/xxxxxxxxxxxxxxxxxxx/
 +
 
 +
where xxxxxxxxxxxxxxxxxxx is your widget ID.
 +
 
 +
You should copy this value and paste into the "Twitter widget ID" field on the Social Feeds module configuration page:
 +
[[File:Sf twitter config.png| border]]
 +
 
 +
=== Configuring YouTube Feed ===
 +
Simply specify your YouTube ID/username in a corresponding field:<br>
 +
[[File:Sf youtube settings.png| border]]
 +
 
 +
=== Configuring Instagram Feed ===
 +
You need to obtain <b>Instagram Client ID</b> and <b>Instagram Client Secret</b><br>
 +
1. Login to your Instagram account<br>
 +
2. Go here http://instagram.com/developer/clients/manage/<br>
 +
3. On the opened page click on the <b>Register a New Client</b> button (you will probably need to fill in your company details first to make this button appear) at the top-right corner and fill the required fields in:<br>
 +
 
 +
'''Application Name''' - any application name, for instance "My_app"<br>
 +
 
 +
'''Description''' - any description<br>
 +
'''Website''' - your website address<br>
 +
 
 +
'''OAuth redirect_uri''' - http://www.example.com/admin/configuration.php?option=Social_Feeds<br>
 +
 
 +
where www.example.com is an address of your X-Cart store.<br>
 +
 
 +
4. After Client is created copy '''Client ID''' and '''Secret''' in the fields below and save the changes. After the page reloads the '''Get Instagram Access Token''' button will appear. Click on it and grant permissions so that the created Client could be able to access your Instagram details:<br>
 +
:[[File:Sf_instagram_config.png| border]]
 +
 
 +
 
 +
5. '''Instagram tag''' - specify a tag if you want to pull images by some tag instead of your account images.
 +
 
 +
[[Category:X-Cart modules]]
 +
[[Category:X-Cart user manual]]

Latest revision as of 13:47, 10 August 2020

Overview

What Social Feeds does

Connect with your customers and build a brand for the cost of some time and creativity. Promote your store and goods via Facebook, Twitter, YouTube, Instagram and other social networks. Our module in its turn gives you a cozy tool for that.

Why Social Feeds?

X-Cart's Social Feeds add-on module:

  • Supports a wide range of social networks: Facebook, Twitter, YouTube, Instagram, Flickr
  • Promotes your store and goods via social networks. You can boast of your new product collection via Instagram, make a video and upload it to YouTube, retweet a feedback and allow your customers to see it from your site.
  • Induce customers to subscribe to your social accounts. Each feed gives an opportunity to subscribe to the channel.
  • Easy to configure. No technical skills are required. Just follow a user guide


System requirements

To be able to successfully install and use the Social Feeds module, you must have a working copy of X-Cart GOLD / GOLD PLUS / PRO / PLATINUM version 4.4.0 or later installed on your server. Make sure that the version of the module is the same as the version of the installed copy of X-Cart.

Note: If you do not remember the version of installed X-Cart, find it in the Environment info section of the Summary page in X-Cart Admin area.

Installation

To install the module for X-Cart 4.4.0 or higher:

  1. Obtain a distribution package for the Social Feeds add-on module by downloading it from the File Area section of your X-Cart Account. The distribution package you need is contained in the archive file social-feeds-x.y.z.tgz where x, y and z are the version numbers of the module. Make sure the version of the module is the same as the version of the installed X-Cart.
  2. Copy the distribution package to the X-Cart root directory on your server or hosting account.
    • If you are using a Windows-based server, or a UNIX-based server without terminal access:
    a) Decompress the archive with the Social Feeds distribution package to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
    b) Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.
    • If you are using a UNIX-based server with terminal access:
    a) Use an FTP client to upload the archive with the distribution package to the X-Cart root directory on your server or your hosting account.
    b) Decompress the package using the following command:
    tar -xzvf social-feeds-x.y.z.tgz
    Important: Make sure you keep the directory structure while unpacking and uploading the distribution package, otherwise some necessary files can be overwritten!
  3. In a web browser, run the installation script httр://<YOUR_XCART_DOMAIN>/install-social-feeds.php replacing the variable <YOUR_XCART_DOMAIN> with the actual domain name of your X-Cart store.
  4. Enter the Auth code, accept the License Agreement and click Next.
  5. The installation script patches the files and activates the module. Click Next to continue the installation.
    Note: if you are using custom skin, you will need to manually apply the patches to it. Otherwise, the module will not work in this skin.
  6. The installation script generates a new system fingerprint. Click Next to complete the installation.
  7. Use the ADMINISTRATOR AREA link to log in to the Admin area.

Enabling the Social Feeds add-on module

After the Social Feeds add-on module installation has been completed, the module you have installed needs to be enabled in your store:

  1. In Admin area, go to the Modules section (Settings menu->Modules).
  2. Choose the Social Feeds module by selecting the respective check box on the left.
  3. Click the Apply changes button. This activates the module.

Configuring Social Feeds add-on module

After the Social Feeds add-on module has been enabled in your store, you should check and adjust its configuration:

  1. In the Modules section (Settings menu->Modules), click the Configure link opposite the module name ('Social Feeds').
    The module configuration page (titled by the name of the module) opens.
  2. Adjust the settings on the module configuration page. Detailed information is available below.
  3. Click the Apply changes button to save the changes.

Configuring Facebook Feed

Simply add the address of your Facebook page and save the changes. Facebook feed will be automatically displayed in your store.:
Facebook config.png

Configuring Twitter Feed

You need to get your Twitter widget ID:

1. Login to Twitter using your account

2. Go to https://twitter.com/settings/widgets/new

3. You may leave all settings default and click on Create Widget button.

4. As a result a widget code will be generated. One of the parameters is named as data-widget-id. Alternatively widget ID can be taken from the URL address as soon as you generate it. It looks like:

https://twitter.com/settings/widgets/xxxxxxxxxxxxxxxxxxx/

where xxxxxxxxxxxxxxxxxxx is your widget ID.

You should copy this value and paste into the "Twitter widget ID" field on the Social Feeds module configuration page: Sf twitter config.png

Configuring YouTube Feed

Simply specify your YouTube ID/username in a corresponding field:
Sf youtube settings.png

Configuring Instagram Feed

You need to obtain Instagram Client ID and Instagram Client Secret
1. Login to your Instagram account
2. Go here http://instagram.com/developer/clients/manage/
3. On the opened page click on the Register a New Client button (you will probably need to fill in your company details first to make this button appear) at the top-right corner and fill the required fields in:

Application Name - any application name, for instance "My_app"

Description - any description
Website - your website address

OAuth redirect_uri - http://www.example.com/admin/configuration.php?option=Social_Feeds

where www.example.com is an address of your X-Cart store.

4. After Client is created copy Client ID and Secret in the fields below and save the changes. After the page reloads the Get Instagram Access Token button will appear. Click on it and grant permissions so that the created Client could be able to access your Instagram details:

Sf instagram config.png


5. Instagram tag - specify a tag if you want to pull images by some tag instead of your account images.

Retrieved from "https://help.x-cart.com/index.php?title=X-Cart:Social_Feeds&oldid=15483"