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.
| Single Sign-On|
Share Bar Plugin
Rating & Reviews
Gigya supports multiple environments:
Core REST API
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.
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.
Common Integration Diagram
The following diagram shows the most common use-case of a web site that integrates the Gigya service:
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.
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.