Using the REST API

Last modified 15:30, 14 Apr 2015

Gigya's REST API is the core of Gigya's service. On top of the REST API, Gigya offers a set of Server Side SDKs that provide wrap around the API. The Server Side SDKs make it simple to integrate Gigya's service in server applications of various development environments.

Check out our Server Side SDKs documentation and find out if there is an SDK available for your preferred language. Otherwise, please continue with this guide and learn how to use our REST API directly.

 

Introduction

Gigya's server-to-server API uses a REST-like interface. This means that the API method calls are made over the internet by sending HTTP GET or POST requests to the Gigya REST API server and the response is returned as XML/JSON. Nearly every software development environment provides methods for communicating over HTTP with a REST server.

Gigya's REST API may be applied in compliance with the OAuth 2.0 standard or with our proprietary authorization method. Please follow one of the following guides, to integrate Gigya's REST API calls, using your preferred authorization method:

 

Using the Gigya API with a User Key

If you are not the main site administrator, you may not have access to the Partner Secret Key. Instead, you can call the GIgya API using your user key and user secret. You still need to pass the API Key of the target site. Note that calls performed this way are subject to the user key's permissions and are logged for auditing purposes.

When you pass a request across HTTPS, include the site's API Key and your personal User Key and Secret. For example:

https://...?apiKey=[SITE_API_KEY]&userKey=[USER_KEY]&secret=[USER_SECRET]

For more information about user keys, including instructions for finding your user key in the Gigya Console, see Using the User Key.

 

The REST API Reference provides specification to the various REST API methods supported by Gigya.

Page statistics
12014 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