Web SDK

Skip to end of metadata
Go to start of metadata

Description

This section is a reference to Gigya's JavaScript Web SDK.

We highly recommend reading the  Using The Web SDK  guide. The guide includes a basic example and instructions for using Gigya's Web SDK methods.

Please see here for supported browsers.

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>

onGigyaServiceReady

onGigyaServiceReady is a variable that the Gigya WebSDK always checks for as soon as it completes loading. 

For Gigya methods to function properly, they can only be called after the Gigya WebSDK finishes loading completely. Attempting to call a method prior to this, will result in an error similar to the following:

Uncaught ReferenceError: gigya is not defined

To ensure that Gigya is always loaded prior to any method calls on your page, you can place all Gigya related functions inside a handler and then call that handler using the onGigyaServiceReady variable.

A code example follows:

function GigyaLoadFunctions() { 
	gigya.accounts.getAccountInfo({
        'callback":function(res) {
			if (res.errorCode === 0;) {
				window.userGigyaData = res;
			}
		}
    });
}
var onGigyaServiceReady = function() {
	GigyaLoadFunctions();
}
 
<script type="text/javascript" src="https://cdns.gigya.com/JS/gigya.js?apiKey=PUT-YOUR-APIKEY-HERE" ></script>

 

Using the above example, after Gigya finishes loading, it will then call the onGigyaServiceReady function which will, in turn, call the GigyaLoadFunctions function.

Gigya's Web SDK consists of the objects and methods listed below: