Magento 1.0

Skip to end of metadata
Go to start of metadata

This guide applies to the Gigya Extension for Magento 1.x. For Magento 2.x, see Magento 2.0.

Overview

The GConnector for Magento 1.0 is an extension that allows you to easily integrate Gigya's Customer Identity and Access Management platform with your Magento store. With the GConnector extension, you can easily build and maintain secure and scalable registration, authentication, profile management, data analytics and third-party integrations. Increase registrations and identify customers across devices, consolidate data into rich customer profiles, and provide better service, products and experiences by integrating data into marketing and service applications.

Gigya is a Magento Silver Industry Partner

Main Features

Customer Identity Management

The Magento GConnector provides two main customer identity management packages:

  1. Registration-as-a-Service (RaaS) - An end-to-end user management system package. This platform offers a comprehensive cloud-based user registration service that supports login by social networks while allowing sites to maintain a single user database that combines social and traditional site authentication. For additional information and advanced implementation options see Registration-as-a-Service.
  2. Social Login - The Gigya Extension can be used as an external authentication system, allowing users to sign up to your site using their social networks while interacting with the standard Magento registration. Users can register and login to your site with their social networks, which the site will manage as conventional Magento user accounts.

Social Plugins (extension blocks)

The GConnector includes a series of plugins (Magento blocks) that integrate your site with users' social networks and create a compelling and fulfilling user experience. These blocks/plugins have a fully configurable user interface design that can be controlled from the Magento admin panel.

Social Plugins 

The Gigya platform includes a series of plugins that integrate your site with users' social networks and create a compelling and fulfilling user experience. These plugins have a fully configurable user interface design:

  • Share – Users can easily Share posts with their social networks friends.
  • Comments – Gigya's Comments plugin enables site users to post comments and have discussions about published content on your site.
  • Loyalty – Also known as "Gamification", this is a social loyalty and rewards platform that can be easily embedded in your website, increasing site engagement and making your users' experience more enjoyable.
  • Reactions – The Reactions plugin allows users to react to content in your site and share their reaction to social networks.
  • Rating & Reviews – The R&R plugins give your customers an easy way to provide feedback on product and content across your site, and then share that feedback with friends in their social networks.

 

Version and Compatibility

Gigya Magento Extension version 3.2 is compatible with Magento Community Edition version 1.x and Magento Enterprise Edition version 1.x.

Installation and Implementation

Prerequisites

  • Magento is implemented in your website and you have access to the Magento Admin Panel.
  • You have an account on Gigya's Console and have set up your site in the Site settings section.

1. Install the Extension

  1. Get the extension key from the extension page.
  2. Download the extension and install it in your Magento site. Refer to Magento's documentation for instructions on downloading and installing a Magento extension.

2. Configure Settings

Sync Base

Data sync between Gigya and the CMS is based on Gigya's UID. This way, user information is independent of any input provided by the user (such as name or email), and passed consistently between systems, so as to provide a seamless integration and improve the users' experience. The UID field is created automatically in the CMS when installing the GConnector. When configuring Gigya for CMS integrations, the email is always the login identifier (included in the loginID). 

We differentiate between two types of CMS: 

  • Email is required and unique (a user identifier in the CMS).
  • Username is required and unique (a user identifier in the CMS).

When Email is the CMS Identifier

When the user's email is an identifier in the CMS, by default, the CMS email field is mapped to the emails stored in Gigya's loginID. This cannot be overridden by field mapping. 

The login/registration flows in this case require that at least one email that is recognized in Gigya as a login identifier is unique to the user. After a user logs in or registers, the flow is as follows:

  1.  Following Gigya's onLogin event, the UID is passed. 
  2. The GConnector checks if the UID exists in the CMS database: 
    • Login: If the UID exists in the database, the system makes sure that at least one of the emails in the loginID is unique to this user, logs the user in and sets that email address in the CMS. If all of the user's loginID emails are saved to other users (other UIDs), the user will not be logged in, and will receive an error.
    • Register: If the UID does not exist, the system makes sure that at least one of the emails in the loginID is unique to this user, registers a new user and sets that email address in the CMS. If all of the user's loginID emails are saved to other users (other UIDs), the user will not be logged in, and will receive an error.

If you are using the profile.email Gigya data field, it should be mapped to a custom email field in the CMS, and not to the default required email field in the CMS.

When Username is the CMS Identifier

  1.  Following Gigya's onLogin event, the UID is passed. 
  2. The GConnector checks if the UID exists in the CMS database: 
    • Login: If the UID exists, the user is logged in. Data is updated according to this flow (required fields are updated before non-required).
    • Registration: If the UID does not exist, a new user is registered in the CMS. Data is saved according to this flow (required fields are updated before non-required).

Changing the Sync Base and Backward Compatibility

In Magento 1.x, email is a required field, and serves as the identifier. By default, the GConnector for Magento 1.x syncs identity data between Gigya and Magento based on the UID. The connector is backward compatible and behavior of older versions of the module does not change automatically, and if you wish to change the behavior, you should consult with your Account Manager for a migration plan. 

All users should have a Gigya UID before migrating to a UID-based sync. Therefore, we advise that you first check your Magento user database to search for users which lack a Gigya UID. To locate any such users, you can download this file and run the SQL query within. The query returns any user for whom a UID is not defined. Any such users should be assigned their Gigya UIDs before changing the sync base.  

To change the sync base of the connector, in Magento's core_config_data table, set the value of the gigyaSyncBase variable:

  • GigyaUID (default for new installations) - the sync base is Gigya's UID.
  • LoginIDsEmail - the sync base is the email saved in the loginID and Magento's email identifier.

Gigya Global Settings

  1. In the Magento admin console, go to System > Configuration > Gigya Global.

  2. In the Gigya Global configuration page, configure the following required settings:
    • Enable: Set to Yes to enable the Gigya extension.
    • Gigya API Key: Enter the Gigya API key of your site.
    • Use Application Key & Application Secret: Choose whether to access Gigya using an Application Key and Application Secret that you have set up specifically for this implementation (BEST PRACTICE). Otherwise the extension will access your data in the Gigya database using your Gigya Secret (less secure). For more information, see Manage Applications.
    • Based on your choice in the previous setting, enter either your Application Key and the accompanying Application Secret, or your Gigya Secret.
    • Data Center Region

    You may configure any of the other settings in this page as needed (see table below for details).
    Click to enlarge screenshot

The Gigya Secret or Application Secret will be encrypted using Magento's encryption capabilities.

The Gigya Global settings page offers the following options:

Required?FieldDefaultDescription
EnableNoEnable or disable the extension.
Gigya API key Copy and paste the API key for your site domain that is generated for you at the Gigya site. To view the API key go to the Gigya Dashboard.
Use App Key & App SecretYesWhether to use a Application Key and Application Secret instead of the Gigya Secret.
Gigya App Key 

(This setting is visible only if you have set Use App Key & App Secret to Yes.)

Enter the Application Key and Application Secret.

Gigya App Secret 
Gigya Secret Key 

(This setting is visible only if you have set Use App Key & App Secret to No.)

Enter your Gigya Secret Key. To view the Gigya Secret go to the Dashboard section of the Gigya Console and click the Show Secret key link next to your Partner ID at the bottom of the site list.

Providers*The default * setting specifies all available social networks. Otherwise type a comma-separated list of social networks that you want to include. For the full list of available providers, refer to the global configuration object  page.
Data Center RegionUS

The Gigya data center associated with your site. See Finding Your Site's Data Center. If your data center is not listed in the drop-down list, select Other and enter your data center URL.

Interface LanguageAuto-Select

Select the Gigya interface language or choose Auto Select to have Gigya use the language set in Magento. See language support for more information on Gigya's localization support.

Fallback LanguageEnglish

(This setting is visible only if you have set Interface Language to Auto Select.)

Choose a language to be used by Gigya if the auto-selected Magento language is not one of the languages supported by Gigya.

Enable Google Social AnalyticsNoSelect Yes to enable the Google Social Analytics plugin. For details, refer to the 3rd-party Analytics Integration  page.
Enable purchase notifications to Customer InsightsNo

Select Yes to have Gigya Signals count purchases and purchase amounts. Signals is a premium feature and requires separate activation. Information from Signals is used in Customer Insights and the accumulated values will show under Revenue Activity in Customer Insights. Customer insights cross references Customer Social Network information (such as Facebook Likes and demographic information) against the customers' activity on your site (such as purchases) and allows you to flexibly break down the data. The data passed to Signals can be customized: see the code example in Advanced Events and Observers.

Enable Gigya debug logNoSelect Yes to have the Gigya extension log all of Gigya's API requests and responses. The logs will appear in Magento's default logging system.
Advanced Configuration(no default)

Specify settings beyond those available in the fields above. Additional parameters must be entered in JSON format: {"param1": "value1",..., "paramN": "valueN"} where "param" represents the name of the API method parameter and "value" is the value you are passing to it.

The Advanced Configuration settings override all other configuration settings, and therefore must be used carefully.

For example, the following use of JSON sets values for the Global Conf object's enabledProviders and ShortURLs parameters:

{"enabledProviders":"facebook, twitter", "shortURLs":"whenRequired"}

Note: The advanced configuration cannot include events. or hooks.

Note for users updating from earlier versions: The Login Behavior setting, which was available in v. 3.1x and earlier of the GConnector, has been deprecated. This option allowed you to determine the system behavior when a user who was not logged in tried to perform a Gigya social action. Following the deprecation, users who are not logged in and who try to share, comment, etc. will always be directed to site login first.

If you have set Login Behavior to anything other than "Always login" in a previous version of the extension, you will no longer be able to change this setting through the admin menu, but you can remove it manually by using magerun and running the following command: magerun config:delete "gigya_global/gigya_global_conf/loginBehavior"

3. Configure Some Required Magento Settings

SEO-Friendly URLs

The GConnector requires that the site works with SEO-friendly URLS, i.e., without index.php. To make sure this is enabled:

  1. In the Magento admin console, go to System > Configuration > Web.
  2. Under Search Engine Optimization, make sure that Use Web Server Rewrites is set to yes.
  3. Make sure that "mod_rewrite" is enabled on the Apache web server.

Disable CAPTCHA Module

Additionally, you must disable the Magento CAPTCHA module (Mage_Captcha). Instructions:

  1. In the Magento admin, go to System > Configuration > Advanced.
  2. Find Mage_Captcha in the module list and select Disable (see image).
    Click to enlarge screenshot

Permissions Best Practice

We recommend creating a role named Gigya Major Admin and assigning Gigya resources to it.

  • Only users with the Gigya Major Admin role will be able to view and edit Gigya settings.

4. (Optional) Implement Gigya User Management

To set up Gigya user management, go to System > Configuration > Gigya > User Management.

There are three basic options:

  • Magento only - This (default) option disables Gigya's login and Gigya's user management. The plugins remain available.
  • Magento + Social Login - This option enables Gigya's social login, allowing users to login to your site using their social networks. User management is handled by Magento.
  • Registration-as-a-Service - This option enables both Gigya's social login and Gigya's Registration-as-a-Service user management, giving you extended data and control over your site users and enabling the RaaS widget.

Click to enlarge screenshot

The specific settings associated with each option are detailed below.

Data Retrieved for New Users: New users registering through Gigya are saved in Magento with the following fields: First Name, Last Name, Email. In Gigya, it is possible to define the user data retrieved from each specific social network by logging into the Gigya Console and going to Site Settings > Permissions. The end users will have to authorize the requested information when they register.

Registration-as-a-Service

To implement Gigya's Registration-as-a-Service, see Using RaaS with Magento.

Magento + Social Login

If you choose to enable Gigya's social login without Gigya's Registration-as-a-Service, the following User Management Settings are displayed:

FieldDefault Description
Gigya Social Login configuration
Button styleIconsShow social network links as Icons or Full Logo.
Show terms linkNoSelect Yes to display a link to the Gigya terms of use agreement.
Gigya login container idgigyaLoginName of the CSS div which holds the Gigya login plugin.
Width210Specify the display width of the login widget in pixels.
Height110Specify the display height of the login widget in pixels.
Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For more information, see above. For the list of available configuration options , refer to the parameter table in the socialize.showLoginUI API page.
Gigya Add Connections configuration (Configures the Add Connections Plugin's appearance. The plugin allows the user to connect to additional social networks.)
Enable Gigya add connectionsNoSelect Yes to enable the plugin.
Gigya add connections container idgigyaAddConnectionsName of the CSS div in which the Gigya login user interface will appear.
Width210Specify the display width of the login widget in pixels.
Height110Specify the display height of the login widget in pixels.
Show terms linkNoSelect Yes to display a link to the Gigya terms of use agreement.
Show edit linkYes

Select Yes to display an Edit link which opens the Edit Connections Plugin.

Advanced configuration(no default)This box enables you to specify configuration options beyond those available in the fields above. For details, refer to the Advanced Configuration section.
For the list of available configuration options , refer to parameters table in the socialize.showLoginUI API page.

Enabling Social Login activates the Gigya Social Login plugin. You do not have to use the plugin and can rely on existing Magento links, which will open the standard Magento login page with added social network options (see image).You can use the Social Login plugin to customize the location of social network logins within your site.

Click to enlarge screenshot

For more information on the Login plugin, refer to the  Login plugin page and to the socialize.showLoginUI API method. Note that the Gigya plugin uses version 2 of both the socialize.showLoginUI and the  socialize.showAddConnectionsUI APIs.

5. (Optional) Implement Gigya Plugins

To implement Gigya's social plugins, see Gigya Plugins Implementation.

Multisite

The Gigya extension supports Magento's multisite (multiple websites/storefronts) capabilities.

Logs

The Gigya extension saves its logs to the default Magento logging system.

There are two logging modes:

  • In regular mode, the extension logs error messages and edits to the Gigya Secret/Application Secret.
  • In debug mode, the extension logs every API call made to Gigya.

To switch between the modes:

  1. In the Magento admin console, go to System > Configuration > Gigya Global Settings.
  2. Set Enable Gigya debug log to "Yes" or "No".

Troubleshooting

Flush Your Cache

  • Make sure to flush your cache every time you make configuration changes.
     

General

  • The server clock must be set to GMT+0, otherwise errors and unexpected behaviors may occur. We recommend using NTP daemon to ensure that the server time is accurate.
  • Gigya screen-sets must entirely replace any login, registration etc. screen provided by the CMS. The CMS registration, login and edit profile screens should not be rendered at all. Otherwise, the Gigya screen is placed inside the CMS screen and both will behave unexpectedly. 
  • After changing the value of the application key, you should re-enter the application secret.

 

Save

Save

Save

Save

Save

Save

Save

Save

Save

Save