Skip to content

Commit

Permalink
Merge pull request SAP#3 from SAP/update_readme
Browse files Browse the repository at this point in the history 
Update README.md and gitignore
  • Loading branch information
@kobico
kobico authored May 19, 2021
2 parents 6c0d481 + f119be5 commit e6f85fa
Show file tree
Hide file tree
Showing 2 changed files with 222 additions and 30 deletions.
4 changes: 1 addition & 3 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
*.pyc

# IntelliJ IDEA
.idea/workspace.xml
.idea/tasks.xml
.idea/dictionaries/
.idea
.DS_Store

getUserInfo.py
248 changes: 221 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,38 +1,232 @@
# Gigya SDK for Python
Learn more: https://developers.gigya.com/display/GD/Python
# Python SDK
*SAP Customer Data Cloud (Gigya)*

## Description
The Python SDK, provides a Python interface for the Gigya API.
The library makes it simple to integrate Gigya services in your Python application.
### Description
The Python SDK provides a Python interface
for the Gigya API. The library makes it simple to integrate Gigya services
in your Python application. This document is a practical step-by-step guide
for programmers who wish to integrate the Gigya service into their Python
application. Follow the steps below to get started,
and use the [Library Reference](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/416a3f1f70b21014bbc5a10ce4041860.html) while implementing.

## Requirements
[Python 2.7 and 3](https://www.python.org/downloads/)
```
Note: Python 2.7.x and 3 are supported.
```

##Library Guide

## Download and Installation
* Clone the repo.
* Open the Project.
Please follow these steps to integrate this library in your Python application:

## Configuration
* [Obtain a Gigya APIKey and Secret key](https://developers.gigya.com/display/GD/Python#Python-ObtainingGigya'sAPIKeyandSecretkey).
* Copy the GSSDK.py file to your Python application path.
* Import the GSSDK.py file into your application:
```Python
1. Download the zip file and extract it
2. Obtain Gigya's APIKey and Secret key.
3. Import GSSDK.py library into your application.
4. Log the user in.
5. Use Gigya's API - Send Requests.
6. Optional: incorporate security measures.

### Obtain Gigya's APIKey and Secret key
Making API calls requires an API Key and a Secret Key which are obtained from the Site DashboardInformation published on non-SAP site 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 parameter in each request (further ahead in this document you will find guidance for sending requests).

### Importing the GSSDK.py Library into Your Application
To get started, you'll need to import Gigya Python SDK to your application:

Copy the GSSDK.py file to your Python application path.
Import the GSSDK.py file into your application:
```python
from GSSDK import *
```
* Start using according to [documentation](https://developers.gigya.com/display/GD/Python).
You should now be able to use the SDK in your project.

### Logging the User in
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 Social Login UI.

To learn more about the login process, see [Social Login](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/417916f470b21014bbc5a10ce4041860.html).

[LoginDiagram]: https://help.sap.com/doc/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/loio40c2081f70b21014bbc5a10ce4041860_LowRes.gif "Login Diagram"

###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":

```python

# Define the API-Key and Secret key (the keys can be obtained from your site setup page on Gigya's website).
apiKey = "PUT-YOUR-APIKEY-HERE"
secretKey = "PUT-YOUR-SECRET-KEY-HERE"

# Step 1 - Defining the request and adding parameters
method = "socialize.setStatus"
params={"uid":"PUT-UID-HERE", "status":"I feel great"} # Set "uid" to the user's ID, and "status" to "I feel great"
request = GSRequest(apiKey,secretKey,method,params)

# Step 2 - Sending the request
response = request.send()

# Step 3 - handling the request's response.
if (response.getErrorCode()==0):
# SUCCESS! response status = OK
print "Success in setStatus operation."
else:
# Error
print "Got error on setStatus: " + response.getErrorMessage()
# You may also log the response: response.getLog()
```

### Step 1: Defining the Request and Adding Parameters
Create a GSRequest instance:

```python

method = "socialize.setStatus"
params={"uid":"PUT-UID-HERE", "status":"I feel great"} # Set "uid" to the user's ID, and "status" to "I feel great"
request = GSRequest(apiKey,secretKey,method,params)
```
The parameters of the GSRequest are:

1. apiKey
2. secretKey
```
Note:
For information about obtaining these keys, see above.
```
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. params - In this case the uid and status.
<pre>
Note:
In the <a href="https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/41735f5270b21014bbc5a10ce4041860.html">REST API reference</a> you may find the list of available Gigya API methods and the list of parameters per each method.
</pre>

### Step 2: Sending the Request
Execute GSRequest's send method:

```python
response = request.send()
```
The method returns a GSResponse object, which is handled in the next step.

```
Note:
By default, requests to Gigya APIs are sent using the "us1.gigya.com" domain. If your site has been set up to use another of Gigya's data centers, you must specify that the request should be sent to that specific data center by adding the following line of code before calling the Send method:
request.setAPIDomain("<Data_Center>")
```


Where *<Data_Center>* is:

**us1.gigya.com** - For the US data center.<br>
**eu1.gigya.com** - For the European data center.<br>
**au1.gigya.com** - For the Australian data center.<br>
**ru1.gigya.com** - For the Russian data center.<br>
**cn1.gigya-api.cn** - For the Chinese data center.<br>

If you are not sure of your site's data center, see [Finding Your Data Center](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/41573b6370b21014bbc5a10ce4041860.html).

See the [GSRequest documentation](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/41467b5670b21014bbc5a10ce4041860.html) for more information.

### Step 3: Handling the Response
Use the GSResponse object to check the status of the response, and to receive response data:

```python
if (response.getErrorCode()==0):
# SUCCESS! response status = OK
print "Success in setStatus operation."
else:
# Error
print "Got error on setStatus: " + response.getErrorMessage()
# You may also log the response: response.getLog()
# You may also log the response: response.getLog()
```
The [GSResponse](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/4146c7ed70b21014bbc5a10ce4041860.html) 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](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/417637a470b21014bbc5a10ce4041860.html) response:

## Limitations
None
The response of 'socialize.getUserInfo' includes a 'user' object.
```python
# Sending 'socialize.getUserInfo' request
params = {"uid", "PUT-UID-HERE"} // set the "uid" parameter to user's ID
request = GSRequest(apiKey,secretKey,"socialize.getUserInfo",params)
response = request.send()

# Handle 'getUserInfo' response
if (response.getErrorCode() == 0):
# SUCCESS! response status = OK
nickname = response.getObject("nickname")
age = response.getObject("age")
print "User name: " + nickname + " The user's age: " + age
else:
print "Got error on getUserInfo: " + response.getErrorMessage()
# You may also log the response: response.getLog()
```

## Known Issues
None
### Optional - Incorporating Security Measures

## How to obtain support
Via SAP standard support.
https://developers.gigya.com/display/GD/Opening+A+Support+Incident
#### Validating Signatures
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.

## Contributing
Via pull request to this repository.
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](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/4147019770b21014bbc5a10ce4041860.html)
class is a utility class for generating and validating signatures.

## To-Do (upcoming changes)
None
For example, Gigya signs the [socialize.getUserInfo](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/417637a470b21014bbc5a10ce4041860.html) method response.
The following code validates the signature received with the 'socialize.getUserInfo' method response:

```python
# Handle 'socialize.getUserInfo' response
if (response.getErrorCode()==0):
# SUCCESS! response status = OK
# Validate the signature:
valid = SigUtils.validateUserSignature(response.getObject("UID"),response.getObject("signatureTimestamp"),
secretKey,response.getObject("UIDSignature"))
if (valid):
print "signature is valid"
else:
print "signature is not valid"
```
The parameters of the [validateUserSignature](https://help.sap.com/viewer/DRAFT/8b8d6fffe113457094a17701f63e3d6a/GIGYA/en-US/4147019770b21014bbc5a10ce4041860.html) 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 DashboardInformation published on non-SAP site 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
If you would like to use Gigya service over HTTPS, you will need to do the following:

Create a GSRequest object using the constructor that receives five parameters.
The additional fifth parameter is a Boolean parameter named useHTTPS. Set this parameter to be **true**.

### Appendix - 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 method has a complex parameter called which defines the user action data to be published. To define the userAction parameter create a JSON object and fill it with data. Fill the object with data as shown in the example below:

```python
# Publish User Action

# Defining the userAction parameter
userAction = {"title":"","userMessage":"This is my user message","description":"This is my description",
"linkBack":"http://google.com",{\"src\":\"http://www.f2h.co.il/logo.jpg\", \"href\":\"http://www.f2h.co.il\",\"type\":\"image\"}}

# Sending 'socialize.publishUserAction' request
params = {"userAction":userAction, "uid":"PUT-UID-HERE"}
request = GSRequest("PUT-YOUR-APIKEY-HERE", "PUT-YOUR-SECRET-KEY-HERE", "socialize.publishUserAction", params)
response = request.send()
```

0 comments on commit e6f85fa

Please sign in to comment.