APIs, SDKs and Connectors

Skip to end of metadata
Go to start of metadata

Integration Overview

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. 

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 and instructions for using Gigya's JavaScript API methods and events. 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 iOSAndroid, and Cordova.

 

Common Integrations 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.

 

Handling The Response

When developing logic to parse any data returned from Gigya it is important to ensure that your code does not use strict serialization/deserialization and is able to iterate through the response's properties, as opposed to expecting a finite number of specific properties. Gigya may add properties without notice and your code should be designed to handle/ignore any unexpected properties gracefully.

 

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.

  • No labels