Was this article helpful?

Using the JavaScript API

Last modified 13:27, 4 Mar 2014

This chapter provides the basic knowledge needed to start developing using Gigya's JavaScript API. We highly recommend reading this document before starting to code.

What's in this Guide?

  • Basic Concepts - the guide starts out with some fundamental concepts that are required for developing applications with Gigya's JavaScript API.
  • Basic Tutorial - continue with a basic example of a web page that uses the Gigya service - the Gigya service "Hello World", and a guide for using Gigya API methods.
  • Events - learn how to handle Events generated by Gigya socialize.
  • Advanced Customizations - advanced customization options that you may apply on your client application.
  • Supported Browsers - Information about Gigya's browser support.

 

Note: In addition to the JavaScript API, Gigya supports SDKs for special platforms such as iPhone and Android.

  

Basic Concepts

ClientAPI-Design-Overview-Diagram.gif

An Asynchronous Programming Model

Gigya uses an asynchronous programming model in which operations are triggered and then run in the background until they are completed. Upon successful or unsuccessful completion, the operation invokes a callback function, which is provided by the developer, and returns a response object that includes the results of the operation. The callback function should handle the response in an appropriate manner, as determined by the application. 

The API Namespaces

The entire range of Gigya functionality is provided as methods of one of the following namespaces: gigya.socialize, gigya.accounts, gigya.comments, gigya.gm, gigya.chat, gigya.ds, and gigya.gcs, thus all methods are referenced with the gigya.<namespace> prefix. 

Making API Calls

All the methods in the Gigya API have a common signature:

gigya.socialize.method_name(params);

The "params" object is actually an object that may contain multiple members. We choose to use this object instead of passing parameters in the "classical" way - this provides flexibility in adding new parameters without "breaking" older code. 

 

 

Was this article helpful?
Pages that link here
Page statistics
11312 view(s) and 5 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments