RaaS Quick Start Guide

Skip to end of metadata
Go to start of metadata

Description

This guide will show you how to quickly get started using Gigya's Registration-as-a-Service (RaaS). The easiest way to start using RaaS is to use Gigya Hosted Screen-Sets on your website for User Registration and Login. By following the steps below you can have a working basic implementation up and running in under 20 minutes.

This guide assumes you have already set up a site in the Gigya Dashboard with a valid API Key.

 

Implementing RaaS Screen-Sets

Note:  The Screen-Set API is part of the  Registration-as-a-Service  package, which is a premium platform that requires separate activation. If it is not part of your site package please contact your Gigya Account Manager or 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.

Screen-Set Quick Start Guide

The following tutorial will show you how to begin using Gigya's Default Screen-Sets as soon as possible, without customization.

The quickest and easiest way to immediately implement Screen-Sets on your site is by using simple HTML links in your sites menu bar.

  1. Add the Gigya Web SDK to your site via the following <script> tag in the head of your pages.

    <script type="text/javascript" src="http://cdn.gigya.com/js/gigya.js?apikey=YOUR-API-KEY-HERE"></script>

    When using Gigya's API's over HTTPS it is important that the script tag in the <head> of your pages reference the HTTPS version of the JS SDK, (note CDNS as opposed to CDN) e.g.,

    <script type="text/javascript" src="https://cdns.gigya.com/js/gigya.js?apikey=YOUR-API-KEY-HERE"></script>
     

    Your API Key is available from the Dashboard of the Gigya Console.
     

  2. Add the viewport <meta> tag to the <head> of your sites pages.  It is important that this is the very first item within the <head> (before the gigya.js script) to ensure proper functionality of the Mobile Screen-Sets.

    <meta name="viewport" content="width=device-width, user-scalable=no">
  3. Add Login, Register, Edit, and Logout links to your menu with the following <href> tags. These links will open the default set of Gigya Screen-Set Dialog popups when clicked.

    1. <a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-RegistrationLogin'});">Login</a>

    2. <a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-RegistrationLogin', startScreen:'gigya-register-screen'});">Register</a>

    3. <a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-ProfileUpdate'});">Edit</a>

    4. <a href="#" onclick="gigya.accounts.logout();">Logout</a>

      Best Practice: To ensure users know they have logged out of your site, it is recommended to use a function, rather than just calling the socialize.logout() method directly, e.g.,

      <script type="text/javascript">
      	function logOutUser() {
      		gigya.accounts.logout();
      		alert ('You have been logged out!');
      	}
      </script>
      <a href="#" onclick="logOutUser();">Logout</a>

      Accounts that had RaaS activated prior to October 26th, 2015 use older versions of Gigya Screen-Sets for their default collection. If you have created new screen-sets since that date to take advantage of the latest Responsive Technology, be sure to change the screen names in the onclick event to reflect the name of your currently used screen-set collection.


       

  4. Navigate to the Policies page of the Gigya Console.



  5. In the Login Identifier, leave Email selected.

  6. In the Link Accounts Support, select All Identities (this will enable users that login using multiple providers to be considered as the same user. If this is not selected and users login with multiple providers using the same email address, you will have multiple accounts created for that user).

  7. In the Default Login & Registration Screen-Set fields, be sure that you have the correct screen-set chosen for both options. (If you are using the Default Screen-Sets, this will already be set to use those).

  8. If your organization uses Terms Of Service, go to the Screen-Sets page of the Gigya Console, find the default-RegistrationLogin and the defaultMobile-RegistrationLogin Screen-Sets and open them via the UI Builder. Navigate to the Registration Screen in the Screens section on the left hand menu. Locate the Terms field and edit the Label section to include the URL of the page containing your Terms Of Service. If your company does not use Terms Of Service, You can remove this field by clicking on the  when you mouse-over it and saving the Screen.

  9. A sample complete code example for reference:

    <html>
    <head>
        <title>Mobile Ready Screen-Set Implementation Example</title>
    	<meta name="viewport" content="width=device-width"><!-- VERY IMPORTANT TO PLACE HERE!! -->
     	<SCRIPT type="text/javascript" lang="javascript" 
    	   src="http://cdn.gigya.com/js/gigya.js?apikey=<YOUR-API-KEY-HERE"></SCRIPT>	   
    </head>
    <body>
    		<a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-RegistrationLogin', mobileScreenSet:'DefaultMobile-RegistrationLogin'});">Login</a>&nbsp;&nbsp;|&nbsp;&nbsp; 
    		<a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-RegistrationLogin', mobileScreenSet:'DefaultMobile-RegistrationLogin', startScreen:'gigya-register-screen'});">Register</a>&nbsp;&nbsp;&nbsp;&nbsp;
    		</br></br></br>
    		<a href="#" onclick="gigya.accounts.showScreenSet({screenSet:'Default-ProfileUpdate', mobileScreenSet:'DefaultMobile-ProfileUpdate'});">Edit Your Profile</a>&nbsp;&nbsp;&nbsp;&nbsp;
    		</br></br></br>
    		<a href="#" onclick="gigya.accounts.logout({callback:onLogout});">Logout</a>&nbsp;&nbsp;&nbsp;&nbsp;
    <script>
    	function onLogout(response) {   
    		if ( response.errorCode == 0 ) {                
    			alert('You are now logged out'); 
    		} 
    		else { 
    			alert('Error :' + response.errorMessage); 
    		} 
    	}
    </script>
    </body>
    </html>

    Notes:

    In order to make the above code work in your environment, please note:

    • The API key in the sample will only work on http://localhost/...
    • To load the page from your domain, modify the value of the "APIKey" field in the code to your own Gigya API Key. A Gigya API Key can be obtained from the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API Key.
    • If you are using https, be sure to further adjust the JS API url to: https://cdns.gigya.com/js/gigya.js?apikey=<Your_API_Key>.


  10. Congratulations! Your site should now have the basic functionality of RaaS Screen-Set Implementation, however, be sure to also review the Next Steps section below.

Important Notes

If you make the Email Address a required field, you must also ensure that there is an Email field on the Registration Completion screen of your Screen-Sets.

If you enable Require Email Verification, then you must also make the Email Address a required field and be sure it is set as required in the site's schema and also ensure that an Email field exists on the Registration Completion screen of your Screen-sets.

Failure to include fields on the Registration Completion screen mapped to the appropriate schema field and set as required (as defined in your Site Policies or via checking the 'Required' checkbox in the items Properties of the UI Builder), will make it impossible for some users to register on your site if their chosen provider does not natively provide the required information (i.e., Twitter does not return an email address).

 

 

More Information

View the following pages for additional information and examples.

Default Gigya Screen-Sets

accounts.showScreenSet method

Demo - Screen-Sets Hosted On Gigya

Lite Registration Quick Start Guide 

Markup Extensions

 

Next Steps

Once you have RaaS successfully integrated within your site there are some additional items to familiarize yourself with.

  • Identity Access
  • Customer Insights
  • Site Groups and SSO

Identity Access

Using Gigya's Identity Access tool you can administrate and manage users through an easy to use graphical user interface.

 

See Identity Access for more information.

Customer Insights

View the demographics of your visitors using Gigya's Customer Insights tool.

 

See Customer Insights for more information.

Site Groups and SSO

Implementing Gigya's Registration-as-a-Service (RaaS) within a Site group requires additional setup. Please see Site Groups and Single Sign-On for detailed instructions.