plug-in_configuration

Google+ Plugin Configuration

A Google+ plug-in can be configured to send real-time guest user profile information to a third party application when a guest logs in successfully using the Google+ plug-in. You can view all the configuration details for the Google+ plugin. Based on the information, a personalized message or personalized offers can be presented to the guest. You can view it by navigating through Portals-> Click the portal name for which you want to configure Google+ plugin-> Settings tab-> plugin configuration -> Google+ icon. Once done with it you need to fill up the details and save it. Once done you will be able to see the configuration settings on the portal specified.

JSON Table

Parameter Data Type Description
success boolean Whether the API call was successful or not.
message String A message indicating the API success or failure.
data application/json A JSON object for the response data.
data/totalCount int The total number of records fetched.
data/gplusConfig application/json A JSON for the Google+ plug-in configuration.
data/gplusConfig/pid int The system-generated ID of the portal.
data/gplusConfig/client_id String The Client ID for the Google+ app configured on the Google+ plug-in.
data/gplusConfig/client_secret String The client secret for the Google+ app configured on the Google+ plug-in.
data/gplusConfig/developer_key String The API key for the Google+ app configured on the Google+ plug-in.
data/gplusConfig/date_created Date The date and time when the plug-in was initially configured.
data/gplusConfig/session_timeout int The time period, in minutes, after which the guest user session expires. The user must re-authenticate to continue using the WiFi service. A value of zero indicates that the user session does not timeout and the user must explicitly log out from the portal. A non-zero timeout configured on the user account takes precedence over the timeout configured on the plug-in, portal, and the SSID profile in Wireless Manager.
data/gplusConfig/blackout_time int The time period in minutes for which a user cannot log in to the portal after his last successful login has timed out. A value of zero indicates no blackout time. The blackout time, including zero value, configured on the user account takes precedence over the blackout time configured on the plug-in, portal, and the SSID profile in Wireless Manager.
data/gplusConfig/date_modified Date The date and time when the plug-in was last re-configured.
data/gplusConfig/landing_url String The URL of the page to which the guest user is redirected to on successful login using this plug-in.
data/gplusConfig/bandwidth_upload_limit int Maximum upload bandwidth, in Kbps, for the guests using this plug-in.
data/gplusConfig/bandwidth_download_limit int Maximum download bandwidth, in Kbps, for the guests using this plug-in.
data/gplusConfig/selected_categories String An array of string values specifying the information that is fetched from the guest users Google+ profile.
data/gplusConfig/all_categories application/json A JSON for all the categories of guest user information that the plug-in can fetch.
data/gplusConfig/callback_url String After authentication, Google+ is provided with this URL so that it can redirect to Guest Manager.

Copy Sample JSON
Sample JSON 
[
{
"success": true,
"message": "Record Found",
"data": {
"totalCount": 1,
"gplusConfig": {
"pid": 6,
"client_id": null,
"client_secret": null,
"developer_key": null,
"date_created": "2018-02-01 13:10:31.655334",
"session_timeout": null,
"blackout_time": null,
"date_modified": null,
"redirect_landing_url": null,
"bandwidth_upload_limit": null,
"bandwidth_download_limit": null,
"redirect_endpoint_id": null,
"redirect_campaign_id": null,
"redirect_type": "redirect_landing_url",
"selected_categories": [
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/plus.login"
],
"all_categories": {
"https://www.googleapis.com/auth/userinfo.email": {
"1": "Users Email"
},
"https://www.googleapis.com/auth/plus.login": {
"2": "Users Location",
"3": "Users Age Range",
"4": "Users Friend Count",
"5": "Users Profile Picture"
}
},
"callback_url": "https://marketverticalanalytics.airtightnw.com/plugin/gplus/auth",
"campaign": null
}
}
}
]
API Calls
Get

/V1.14/portals/{pid}/gplus/config

Put

/V1.14/portals/{pid}/gplus/config

Get Google+ Plugin Configuration

Description This API is used to fetch the configuration details of the Google+ plug-in for a specified portal.
Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/portals/{pid}/gplus/config

Here,

  • pid

    It is the unique ID of the portal for which the Google+ plug-in configuration has to be fetched.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/6/gplus/config
Request Body This API call does not require any request body parameters.
Response Body The API returns the details of Google+ plug-in configuration in the response body.
The response is in the application/json format.

Edit Google+ Plugin Configuration

Description This API is used to modify the configuration details of the Google+ plug-in for a specified portal.
Syntax
PUT <Base_URL>/portals/{pid}/gplus/config

Here,

  • pid

    It is the unique ID of the portal for which the Google+ plug-in configuration has to be fetched.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/gplus/config
Request Body This API call does not require any request body parameters.
Response Body The API takes the plug-in configuration details to be updated as parameters in the request body.
The response is in the application/json format.