LinkedIn Plugin Configuration
A LinkedIn 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 LinkedIn plug-in. You can view all the configuration details for the LinkedIn 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 LinkedIn plugin-> Settings tab-> plugin configuration -> LinkedIn 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/linkdConfig | application/json | A JSON for the LinkedIn plug-in configuration. |
| data/linkdConfig/pid | int | The system-generated ID of the portal. |
| data/linkdConfig/client_id | String | The Client ID for the LinkedIn app configured on the LinkedIn plug-in. |
| data/linkdConfig/client_secret | String | The client secret for the LinkedIn app configured on the LinkedIn plug-in. |
| data/linkdConfig/follow_page | String | The LinkedIn follow page URL configured on the LinkedIn plug-in. |
| data/linkdConfig/follow_page_display | int | Whether the LinkedIn follow page must be displayed to the guest user or not. |
| data/linkdConfig/date_created | Date | The date and time when the plug-in was initially configured. |
| data/linkdConfig/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/linkdConfig/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/linkdConfig/date_modified | Date | The date and time when the plug-in was last re-configured. |
| data/linkdConfig/landing_url | String | The URL of the page to which the guest user is redirected to on successful login using this plug-in. |
| data/linkdConfig/bandwidth_upload_limit | int | Maximum upload bandwidth, in Kbps, for the guests using this plug-in. |
| data/linkdConfig/bandwidth_download_limit | int | Maximum download bandwidth, in Kbps, for the guests using this plug-in. |
| data/linkdConfig/selected_categories | String | An array of string values specifying the information that is fetched from the guest users LinkedIn profile. |
| data/linkdConfig/all_categories | application/json | A JSON for all the categories of guest user information that the plug-in can fetch. |
| data/linkdConfig/callback_url | String | After authentication, LinkedIn 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,
"linkdConfig": {
"pid": 6,
"client_id": null,
"client_secret": null,
"follow_page": null,
"follow_page_display": 0,
"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": [
"r_emailaddress",
"r_contactinfo",
"r_fullprofile"
],
"all_categories": {
"r_emailaddress": {
"1": "User Email Address"
},
"r_contactinfo": {
"2": "User Phone Numbers"
},
"r_fullprofile": {
"3": "User Languages",
"4": "Users Followers",
"5": "User Date of Birth"
}
},
"callback_url": "https://marketverticalanalytics.airtightnw.com/plugin/linkedin/auth",
"campaign": null
}
}
}
]
API Calls
/V1.14/portals/{pid}/linkedin/config
/V1.14/portals/{pid}/linkedin/config