The PHP SDK provides a PHP interface for the Gigya API. The library makes it simple to integrate Gigya's services in your PHP application. This document is a practical step-by-step guide for programmers who wish to integrate the Gigya service into their PHP application. Follow the steps below to get started, and use the Library Reference while implementing.
- PHP 5.x.
- PHP 7.x.
Library Guide and Download
Please follow these steps to integrate this library in your PHP application:
- Download the PHP SDK: ( .zip , .rar ). The archive includes the GSSDK.php and a GSSDK.lib folder which includes the cacert.pem and class files. Extract the entire archive to the same location. If you are upgrading from a former version, please make sure to read the SDK's Change Log.
- Obtain Gigya's APIKey and Secret key.
- Include GSSDK.php in your PHP application.
- Log the user in.
- Use Gigya's API - Send Requests.
- Optional - Incorporate security measures.
Obtaining Gigya's APIKey and Secret key
Making API calls requires an API Key and a Secret Key which are obtained from the Site Dashboard page on the Gigya website. The Secret Key must be kept secret and never transmitted to an untrusted client or over insecure networks. The API Key and the Secret Key are required parameters in each request (further ahead in this document you will find guidance for sending requests).
Including GSSDK in your PHP Application
To get started, you'll need to add Gigya PHP SDK to your application:
- Copy all PHP SDK files to the same location of your PHP application path.
- Include the GSSDK.php file in your PHP application:
Give the relative path to the location of the GSSDK.php file.
You should now be able to compile your project successfully.
Logging in the User
The first interaction with Gigya must always be logging in. If the user is not logged in, you cannot access their social profile nor perform social activities, such as setting their status. Sending requests requires an identified Gigya user (the identification of whom is performed using the UID parameter) with an active session. A user session is created when a user logs in via the Gigya service. Log users in through your client application using our Web SDK methods: socialize.login, socialize.notifyLogin, or using our ready made Login Add-on.
To learn more about the login process, see Social Login.
Sending a Request
After you have logged in the user, you may use the GSRequest class to access the user profile and perform various activities. This is implemented using GSRequest's send method. The following code sends a request to set the current user's status to "I feel great":
Step 1: Defining the request
Create a GSRequest instance:
The parameters of the GSRequest constructor are:
- 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.
Step 2: Adding parameters
Step 3: Sending the request
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:
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.
Optional - Incorporating Security Measures
Signature validation is only necessary and supported when validating the signature of a response that was received on the client side and then passed to the server. Server-to-server calls do not contain the UIDSignature or signatureTimestamp properties in the response.
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:
The parameters of the validateUserSignature method are:
- UID - the user's unique ID
- 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.
- 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).
- 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.
Appendix I - Publish User Action Example
The following code sample sends a request to publish a user action to the newsfeed stream on all the connected providers which support this feature.
The socialize.publishUserAction method has a complex parameter called userAction which defines the user action data to be published. To define the userAction parameter create GSObject object and fill it with data. There are two ways to fill the GSObject with data, you can either use the put method or construct the GSObject with a JSON string, as shown in the two examples below:
Option A - Using GSObject's put method
Option B - Construct a GSObject from JSON string
To learn more about publishing user actions, please read the Advanced Sharing guide.
Appendix II - Demo Site