Developer's Guide

Skip to end of metadata
Go to start of metadata


Welcome to the developer's documentation of the Gigya service. The Developer's Guide is a practical tutorial-like guide for developers who wish to integrate the Gigya service into their website/application. The Gigya service supports a wide range of social login, sharing and community features throughout your site. Below you will find a summary of popular features and the quick links you need to get started. 


Customer Identity Management

      Social Login

  • Easy login solution for more than 20 identity providers.
  • Choice of wizard-configurable plugin or API for easy implementation.
  • Manages account linking between user’s existing site account and social identities.
  • Enables access to rich profile data including email addresses.
  • Provides standardized data field structure and nomenclature across identity providers.

    Implementation Guide   Working Example

  • An end-to-end cloud-based user management system package.
  • Toolset for building and managing registration and profile management workflows across your web and mobile properties.
  • Fully customizable.

    Implementation Guide   |  View Demo

      Profile Management
  • Automatically capture social profile data as users perform Social Login/Registration on your site.
  • Dynamic fully indexed schemaless cloud-hosted database.
  • Full control over your user database, allowing you to search, edit, update, delete, target, and export user segments.

    Implementation Guide

      Identity Access

      Single Sign-On
  • Sync users’ login state across multiple web sites.
  • Fully integrated with your current registration
    system and Gigya's Social Login.

    Implementation Guide


Social Plugins

      Share Bar Plugin






      Rating & Reviews


      Action-based Sharing







  • Reward-based social loyalty solution.
  • Powerful and highly customizable plugins.
  • Simple integration with Gigya's social platform.

    Implementation Guide  |  Working Example         



Integration Overview

Gigya supports multiple environments:


The core of the Gigya service is a REST-like interface. Please refer to the REST API reference for the list of methods and parameters. Gigya offers various wraps around this API for various environments, thus in most cases you will not need to use the REST API directly. The wraps are listed below.

JavaScript API

Gigya's JavaScript API is your access to Gigya's plugins. The JavaScript API provides a wrap around Gigya's REST API, in addition to implementing the plugins, which are listed above. We highly recommend reading the Using the JavaScript API guide, which provides the basic knowledge needed to start developing using the Gigya JavaScript API. The guide includes a basic example using the API (e.g., the "Hello World" of Gigya) and instructions for using Gigya's JavaScript API methods and events. Please refer to the JavaScript API Reference for the list of methods and parameters.

Server Side SDKs

Gigya offers a set of Server Side SDKs that provide a wrap around Gigya's REST API. The SDKs make it simple to integrate Gigya's service in various development environments. Check out our Server Side SDKs documentation and find out if there is an SDK available for your preferred language.

Moblie SDKs

Gigya supports SDKs for iOS, Android mobile platforms.

Common Integration Diagram

The following diagram shows the most common use-case of a web site that integrates the Gigya service:


Your website client application uses the JavaScript API to integrate the plugins and client site API method calls.
Your website server application uses a server side SDK for server API method calls. Choose the Server Side SDKs that matches your environment.
If there is no SDK available for your platform (e.g., Perl, Ruby), you may use an external OAuth2 SDK as a wrap around our REST API. Learn more here.


API Key and Site Setup

Gigya plugins and API calls require passing an API key. The API key is a unique key, which is used to verify that API calls are made from an authorized domain. You may obtain your Gigya API key from the Site Dashboard of the Gigya Console (see also the Site Setup documentation).

Development on localhost: For development and testing purposes, it is possible to run Gigya on 'localhost' and with any valid API key. You do not have to sign up in order to run a test on your localhost. You may use the API key that is provided in the various code samples throughout the wiki (see Working Code Examples). Copy the code, and run it on your localhost without any change. After signing up for the domain on which you will deploy, you may use your API key for development on localhost.

Deployment: Before deploying, you must complete your Site Setup, including Configuring Social Network Application Keys. Please make sure that all the pages that use Gigya API include your unique API key. Make sure that the domain name from which you load the pages is the same domain name that you used for generating the API key.


Learn More

Using this Developer's Guide, you can:

  • Learn how to incorporate Security functionality into your integration with Gigya.
  • Learn about Gigya's Reports & Analytics.
  • Learn how Gigya is supported in Mobile applications and sites.
  • Check out Gigya's Demo Sites. Gigya currently maintains two demo sites:
    • The first demo site outlines how to make a web site social using Gigya's social plugins. To learn about the site implementation, how to install the site and more please refer to the Demo Site Guide.
    • The second demo site outlines the same website, only using Registration-as-a-Service to implement the site's user management system.
  • Learn about Debugging Tools that will help you debug your integration with Gigya.