Table of Contents
- 1. Add Your Site
- 2. Approved URLs
- 3. Configure Domain Alias (CNAME)
- 4. Custom URL Shortening
- 5. Redirect Method
- 6. Encryption
- 7. Configure Social Network Application Keys
- 8. Facebook and Google+ Configuration
- 9. Gigya Support
- 10. Admin
The following guide walks through Gigya's setup and serves as a reference document for the configuration options.
If you are not signed in to Gigya, please go to http://www.gigya.com/ and sign in or register, by clicking the Try Gigya button on the top right-hand corner of Gigya's site.
Add Your Site
Once you sign in to Gigya, you will be able to view your Dashboard. The first thing you must do to get your Gigya implementation up and running, is add your site domain name to the sites table in the Dashboard page.
Fill in the site domain, and optionally a description, and press "Add Site":
Note: A valid domain should be entered in the form of "mysite.com" (there is no need to include the "http://" prefix). If you are using Gigya in Flash applications, please enter the URL of the location from where your SWF files are stored and downloaded.
Domain references are defined in Gigya's dashboard, externally in social network app definition pages, and when using Gigya's SDKs to set the domain (in particular the APIDomain field in class GSRequest).
Your domain name should now be listed in the Sites table:
The API key that is associated with your domain is next to the domain name in the table. This API key will be used in every page in which Gigya plugins or API calls are integrated.
The partner ID is displayed at the bottom of the table.
The "Secret Key" is provided at the bottom of the table. This key may be used to generate and check Cryptographic Signatures to verify the authenticity of Gigya processes and prevent fraud. Read more about the subject in the Security page of our Developer's Guide.
Technically you are now ready to use Gigya in your application.
The configuration form provides instructions for setting up site URLs. Please follow them to setup any URLs you wish to include in this configuration. If the Gigya service configuration applies to all parts of your site, you will not need to change the default configuration. However, if you wish to configure specific parts of your site to work under these settings, you can use the URL settings to:
Apply the configuration to specific subdomains only (i.e. "articles.yoursite.com").
Apply the configuration to specific paths (i.e. *.yoursite.com/articles/*)
Configure Domain Alias (CNAME)
Redirecting users to your site from the Facebook "via" link in newsfeed items.
Featuring your site in the OpenID authentication flow. Users will be prompted to allow your site (instead of allowing socialize.us1.gigya.com) to access the user’s OpenID data.
A better user experience on platforms such as iPhone, Android, Windows Mobile.
To apply this with Gigya:
There are two methods you can use to define a CNAME entry in your DNS server:
Contact your provider and request a CNAME entry. Specify a new subdomain in your site and point it to client-proxy.us1.gigya.com or client-proxy.eu1.gigya.com.
Define a CNAME entry in your DNS server. Specify a new subdomain in your site and point it to client-proxy.us1.gigya.com or client-proxy.eu1.gigya.com
login.yoursite.com CNAME client-proxy.us1.gigya.com
Note: the CNAME must be a subdomain of your site. In other words the CNAME must end with your site name.
Return to Gigya settings and enter your CNAME value in the corresponding text-field (see screenshot below).
Note: only a subdomain of the domain which you have configured in Step 1 will be accepted.
You can choose to enable CNAME for all OpenID providers - this will enable sites that use Social Login via OpenID to display their own domain name in the Social Login dialogs instead of "Gigya socialize":Note: This option will not work with CDN acceleration (DSA)
Custom URL Shortening
Gigya includes a URL shortening service for URLs that you publish to social networks using Gigya's API. If Gigya's URL shortening service is active, each of the distributed URLs will be shortened to a URL with the fw.to domain for customers using the US data center or the shr.gs domain for customers using the European data center.
If you wish to set up a custom short URL that will be used when publishing content to social networks:
Define a CNAME entry in your DNS server. There are two methods you can use to define a CNAME entry in your DNS server: either contact your provider and request a CNAME entry, or define a CNAME entry in your DNS server. Specify your short domain and point it to fw.to (US data center) or shr.gs (European data center). For example:
short.yoursite.com CNAME fw.to
Return to Gigya settings and enter your CNAME value in the corresponding text field (see screenshot below).
You can select your short URL redirect method out of the following options:
- Server redirect, replacing existing URL fragment - Use HTTP 302 redirect and append a new URL fragment or replace the existing fragment
- Server redirect, append to existing URL fragment - Use HTTP 302 redirect and append a new URL fragment or concatenate to an existing fragment like a query string (with & separator)
- Server redirect, append query string if URL fragment exists - Use HTTP 302 redirect and append a new URL fragment if one doesn't already exist and a query string if a URL fragment does exist on the target URL
Gigya encrypts usernames, emails, friends' names and friends' emails. Encrypted fields are stored and transmitted encrypted. Gigya manages decryption.
Personal identity information (PII) is also encrypted but can be switched off if the Enable PII encryption checkbox is de-selected in the Site Settings:
When Enable PII encryption is checked, the following fields are encrypted:
- In the Profile object: "firstName", "lastName", "address", "name", "phones".
- In the Identity object: "firstName", "lastName", "address", "phones".
Note that SQL-like queries such as accounts.search, IDS.search and the Identity Query Tool cannot use comparison operators (>, >=, <, <=) or regex expressions on encrypted fields. Contains is case insensitive on encrypted fields but does not support searches for partial strings.
For more information see Security & Privacy.
Configure Social Network Application Keys
Press the "Providers Configurations" tab under the "Site Settings".
You will be directed to the Providers Configurations page, where you must configure social network application keys.
The Gigya service uses external applications to deliver its services in social networks. The external applications act as mediators, enabling the Gigya service to provide the various functions it offers – such as retrieving user info or sending notifications.
For the Gigya service to work in your site, a dedicated external application is required for each social network you wish to use.
The following tutorials will guide you through the process of opening and setting up external applications:
- Setting Up an External Application in Spiceworks
We will be glad to assist if you need help with this process. You can contact us by filling in a support form on our site.
This is a screenshot of the form in Gigya website Providers Configurations for setting up social networks external applications:
Considerations for SN Apps when SSO is Enabled
When SSO is enabled, sites have the option of only configuring apps at the parent level, which will then apply to all child sites. However, if the site defines an application that is not the default (group) application (at the parent level), then the child site's application will be used, overriding the group application. The implications are:
- A user may not connect to different accounts of the same SN in different sites. So if the user connected to FB account #1 in site A he must connect to the same FB account in site B or he will get an error.
- When a user is logged out and then logs in for the first time to a site that belongs to the group using a social identity that was already used in a different site in the group he should be connected to the same group account as he was before.
- When disconnecting from a provider on one site, all the connections for that provider (on all other sites) should be removed.
Facebook and Google+ Configuration
When you click on the Facebook icon, the following dialog opens. A similar dialog opens for Google+, without the External Application Canvas page and API version selection.
Facebook API v2.0
Check the Facebook API version that you wish to use. V2.0 consist of a different set of behavior and permissions.
For more information on API v2.0 go to the Facebook permissions page.
Gigya supports backwards compatibility, so apps made using API v1.0 can change their app to use v2.0 through their app configuration in the console.
Apps that were created past April 30th 2014 will automatically use the v2.0 API calls.
Check this box if you are using a CName.
Enable Native SDK Capabilities
Checking Native SDK Capabilities in Facebook app configuration enables automatic session renewal for users logged in through Facebook and automatic login when autoLogin is set to "true" in the Global Conf object.
In socialize.showLoginUI the parameters autoDetectUserProviders and facepilePosition (allowing use of Facepile) require native SDK capabilities.
Calling socialize.logout to log the user out of Facebook requires native SDK capabilities.
Note that "Native SDK capabilities" also require that Facebook App definitions have your domain specified in the "Valid OAuth redirect URIs" in the Settings Tab (Advanced: Security).
Checking Native SDK Capabilities in Google+ app Configuration enables automatic login when autoLogin is set to "true" in the Global Conf object. This is required for Google+ cross device SSO (also known as cross platform single sign-on): Users who are already logged in on one platform (for example their mobile phone) can use their Google+ credentials to open the site on another platform (for example their laptop) without being asked to sign-in again. App permissions are automatically shared across the different devices.
Calling socialize.logout to log the user out of Google+ requires native SDK capabilities.
Facebook External Application Canvas Page
We will be glad to assist you with implementation, configuration, or any other issues. You can contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site:
Fill in the form and you will receive the support you need.
If you have "Admin" status on your site, you can access the "Admin" link placed on the upper menu:
As administrator, you can:
- Manage Users - you can add, edit, and delete users, and change their account permissions.
- Export Chat Logs - you can download a CSV file of your chats for backup purposes.