.NET

Step 1: Defining the request

Create a GSRequest instance:

string method = "socialize.setStatus";
GSRequest request = new GSRequest(apiKey, secretKey, method, false);

The parameters of the GSRequest constructor are:

1. apiKey
2. secretKey
   Note: Read above about obtaining both of these keys from Gigya's site.
3. method - the Gigya API method to call, including namespace. For example: 'socialize.getUserInfo'. Please refer to the REST API reference for the list of available methods.
4. Whether or not to send the request over HTTPS.

Step 2: Adding parameters

After creating the GSRequest object, use the setParam method to add parameters to the request:

request.SetParam("param1", "value1"); 
request.SetParam("param2", "value2"); 
request.SetParam("param3", "value3");
...

When a parameter is a complex object, use the GSObject class. See example in the Appendix below.

Note: in the REST API reference you may find the list of available Gigya API methods and the list of parameters per each method.

Step 3: Sending the request

Execute GSRequest's Send method:

GSResponse response = request.Send();

The method returns a GSResponse object, which is handled in the next step.

Step 3: Handling the Response

Use the GSResponse object to check the status of the response, and to receive response data:

if(response.GetErrorCode()==0)
{    // SUCCESS! response status = OK   
	Console.WriteLine("Success in setStatus operation.");
} 
else 
{  // Error
	 Console.WriteLine("Got error on setStatus: {0}", response.GetLog());
}

The GSResponse object includes data fields. For each request method, the response data fields are different. Please refer to the Gigya REST API reference for the list of response data fields per method.
For example - handling a socialize.getUserInfo response:
The response of 'socialize.getUserInfo' includes a 'user' object.

// Sending 'socialize.getUserInfo' request
GSRequest request = new GSRequest(apiKey, secretKey, "socialize.getUserInfo", false);
request.SetParam("uid", "PUT-UID-HERE");  // set the "uid" parameter to user's ID
GSResponse response = request.Send();

// Handle 'getUserInfo' response 
if (response.GetErrorCode() == 0)
{  
	// SUCCESS! response status = OK
	string nickname = response.GetString("nickname", "");
	int age = response.GetInt("age", 0);
	Console.WriteLine("User name: {0}; The user's age: {1}", nickname, age);
}
else
{
	Console.WriteLine("Got error on getUserInfo: {0}", response.GetLog());
}

Validating Signatures

The Gigya service supports a mechanism to verify the authenticity of the Gigya processes, to prevent fraud. When Gigya sends you information about a user, your server needs to know that it is actually coming from Gigya. For that cause, Gigya attaches a cryptographic signature to the responses that include user information. We highly recommend validating the signature. The SigUtils class is a utility class for generating and validating signatures.

For example, Gigya signs the socialize.getUserInfo method response. The following code validates the signature received with the 'socialize.getUserInfo' method response:

// Handle 'getUserInfo' response 
if (response.GetErrorCode() == 0)
{
	// SUCCESS! response status = OK
	// Validate the signature
	bool valid = SigUtils.ValidateUserSignature(response.GetString("UID", ""), response.GetString("signatureTimestamp", ""),
			secretKey, response.GetString("UIDSignature", ""));

	if (valid)
		Console.WriteLine("signature is valid");
	else
		Console.WriteLine("Fraud!!!");
}

The parameters of the ValidateUserSignature method are:

1. UID - the user's unique ID
2. signatureTimestamp - The GMT time of the response in UNIX time format (i.e. the number of seconds since Jan. 1st 1970). The method validates that the timestamp is within five minutes of the current time on your server.
3. secretKey - The key to verification is your partner's "Secret Key". Your secret key (provided in BASE64 encoding) is located at the bottom of the Dashboard section on Gigya's website (Read more above).
4. UIDSignature - the cryptographic signature.

All the parameters, with the exception of the secretKey, should be taken from the 'User' object received with the 'getUserInfo' method response.
The method returns a Boolean value, signifying if the signature is valid or not.

In a similar fashion, when using the 'getFriendsInfo' method, The method response include a collection of 'Friend' objects. Each Friend object will be signed with a cryptographic signature. To verify the signature of a friend object, please use the ValidateFriendSignature method.

Sending Requests over HTTPS

To use Gigya service over HTTPS, all you need to do is:

When creating a GSRequest object, set the useHTTPS Boolean parameter to be true.

boolean useHTTPS = true;            // send the request over HTTPS
GSRequest request = new GSRequest(apiKey, secretKey, method, useHTTPS);