Backplane

Skip to end of metadata
Go to start of metadata

Overview

Gigya supports the Backplane protocol, which means that Gigya's Customer Identity Management can be integrated with Backplane-compliant applications using the Backplane protocol.

Backplane is an on-site message bus that connects applications from different vendors on one site. The Backplane system consists of a JavaScript library that is used by the on-page components, and a Backplane server. Learn more about the Backplane protocol on their Official Backplane Site.

The Backplane protocol currently supports login, logout and update scenarios - in which an identity provider publishes a relevant message (with the user info) on the message bus, and applications on the page, for instance, a comment plugin, can listen to the messages and update accordingly.

This guide explains how to integrate the Backplane Protocol into your website. When you are finished, your site will be able to publish messages to a channel on a Backplane Server.

There is no need for any further configuration if your website is already using Backplane-compliant widgets and web apps. See our list of supported technologies for more information.
Note: You must have access to an active Backplane server.

Technologies Used

  • HTML markup and DOM
  • Javascript XMLHTTP and asynchronous events
  • JSON/JSONP

Backplane Flow

Implementation

We recommend that you implement the latest 2.0 version of the Backplane Protocol.

Note: the below steps have to be performed prior to loading and using Gigya's libraries.

The steps for integrating Backplane protocol on your website are:

  1. Obtain the following from your Gigya Implementation Consultant, or from your Backplane provider:
    • Backplane JavaScript library
    • Server URL
    • Bus name and credentials 
  2. Add the Backplane JavaScript library.
    Place the following code in the section of the webpage hosting the widgets: 

    <script type="text/javascript" src="http://cdn.gigya.com/js/backplane2.js"></script>

    Replace "http://cdn.gigya.com/js/backplane2.js" with the Backplane JavaScript library obtained in Step 1.

    This script adds the library to the web page that the Backplane server uses. Any Backplane-compliant widgets on this web page will have access to the Backplane bus, regardless of who created them.
     

  3. Initialize the Backplane object.

    Add the code below to the section of the web page, replacing the busName value with the one obtained in Step 1.
    The "Backplane.init" function should be called before the first Backplane supported application constructor call and before the Gigya JS client is initialized.

    <script type="text/javascript">
    Backplane.init({
    	serverBaseURL: "http://backplane.gigya.com/v2", 
    	busName: "YOUR_BUS_NAME"
    });    
    </script>

    Replace "http://backplane.gigya.com/v2" with the Server URL and "YOUR_BUS_NAME" with the Bus name, both obtained in Step 1.

The Backplane.init method requests a channel on the server and initializes the Backplane object and associated cookies. The process is asynchronous and does not affect web page load times.

Add to Your Application

The following directions are for widget or application developers adding Backplane functionality to a standalone application or a web application (as opposed to a website).

Once implemented, your widget or web app will be configured to listen to a Backplane Server, and will be able to be deployed in any Backplane-enabled site.

Integration Steps

  1. Obtain authentication credentials for your specific bus.
  2. Set up the application to listen for Backplane messages.
  3. Implement a logout.