Was this article helpful?

socialize.notifyRegistration

Last modified 11:47, 15 Sep 2014

Description

This API method notifies the Gigya service that the user has completed the registration process at your site. Gigya then completes the user's login process.
If you pass the optional "siteUID" parameter with this method (see the table of parameters below), this method also acts like the socialize.setUID method, replacing Gigya UID in the user account with the site UID that you provide.

 

Call this method in the following scenarios:

  1. The basic scenario: A new user has registered through Gigya (using a social network).
    Call notifyRegistration immediately after you have stored the new user in your database. Set the "siteUID" parameter (see table of parameters below) with the user ID which you have designated to this user in your database.

  2. The advanced scenario (optional): Link an existing site account to a social network identity.

Both scenarios are fully described in the Social Login guide.

 

The consequences and advantages of using the optional "siteUID" parameter:

  • It simplifies your site development, in the following manner: you continue using your site User IDs (rather than Gigya's UIDs) thus avoiding the need to alter your database.
  • This operation practically links the current user's Gigya account to his account on your user management system.
    Thus, allowing users to sign in either by using their site credentials or by using their preferred provider? and both would lead to the same site account, so as to provide an improved user experience.

 

Request URL

http[s]://socialize.gigya.com/socialize.notifyRegistration

 

Parameters

Required Name Type Description
Required* UIDstringThe unique ID of the user, with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user.
* The UID parameter is required when you call this method through one of the following interfaces: PHP SDK, Java SDK, NET SDK or if you are using the REST API directly with Gigya's proprietary authorization method.
* The UID parameter is not required when you call this method through one of the following interfaces: Android SDK, iOS SDK or if you are using an external OAuth2 SDK.
Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.
Optional siteUID string The user ID which you have designated to the current user on your user management system. This site UID must be different than the Gigya ID.
Note: the parameter accepts only ASCII characters (not unicode) and up to 252 characters.
  cid string A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
  format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
  callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
  httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if occurs.
The following parameters are Required only when calling the method from client side (e.g. using a Mobile SDK) and if you pass the siteUID parameter with this method.: 
  UIDSig string The UIDSig is an HMAC-SHA1 signature proving the authenticity of the data. The signature construction should be implemented on your server side. You can read more in Constructing a Signature.
  UIDTimestamp string The UIDTimestamp is the current GMT time when request is made. The expected format is the Unix time format (i.e. the number of seconds since Jan. 1st 1970). Gigya will check the time difference between the timestamp and the time on Gigya's server when this request is received. If the time difference is more than 5 minutes, the request is considered forged. Please make sure that the UIDTimestamp holds the same timestamp used in the construction of the UIDSig parameter. You can read more in Constructing a Signature.

 

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

 

Response Data

Field Type Description
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
callId string Unique identifier of the transaction, for debugging purposes.

Note: A field that does not contain data, will not appear in the response.

 

Response Example

{
    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "3353d2fbac894289977c102298df60d1"
}

.

Was this article helpful?
Pages that link here
Page statistics
711 view(s) and 1 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