plug-in_configuration

Facebook Plugin Configuration

A Facebook 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 Facebook plug-in. You can view all the configuration details for the Facebook 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 Facebook plugin-> Settings tab-> plugin configuration -> Facebook 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/fbConfig application/json A JSON for the Facebook plug-in configuration.
data/fbConfig/pid int The system-generated ID of the portal.
data/fbConfig/app_id String The App ID for the Facebook app configured on the Facebook plug-in.
data/fbConfig/app_secret String The App secret for the Facebook app configured on the Facebook plug-in.
data/fbConfig/like_page String The Facebook Like page URL configured on the Facebook plug-in.
data/fbConfig/like_page_display int Whether the Facebook Like page must be displayed to the guest user or not.
data/fbConfig/date_created Date The date and time when the plug-in was initially configured.
data/fbConfig/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/fbConfig/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/fbConfig/date_modified Date The date and time when the plug-in was last re-configured.
data/fbConfig/landing_url String The URL of the page to which the guest user is redirected to on successful login using this plug-in.
data/fbConfig/bandwidth_upload_limit int Maximum upload bandwidth, in Kbps, for the guests using this plug-in.
data/fbConfig/bandwidth_download_limit int Maximum download bandwidth, in Kbps, for the guests using this plug-in.
data/fbConfig/selected_categories String An array of string values specifying the information that is fetched from the guest users Facebook profile.
data/fbConfig/all_categories application/json A JSON for all the categories of guest user information that the plug-in can fetch.
data/fbConfig/all_categories/email String The Facebook property used to fetch the guest user’s email.
data/fbConfig/all_categories/user_birthday String The Facebook property used to fetch the guest user’s birthday.
data/fbConfig/all_categories/user_likes String The Facebook property used to fetch the guest user’s likes.
data/fbConfig/all_categories/user_location String The Facebook property used to fetch the guest user’s location.

Copy Sample JSON
Sample JSON 
[
{
    "success": true,
    "message": "Record Found",
    "data": {
        "totalCount": 1,
        "fbConfig": {
            "pid": 6,
            "app_id": null,
            "app_secret": null,
            "like_page": null,
            "like_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": [
                "email",
                "user_birthday",
                "user_likes",
                "user_location"
            ],
            "all_categories": {
                "email": "User EmailID",
                "user_birthday": "Users Birthday",
                "user_likes": "User Likes",
                "user_location": "User Location"
            },
            "campaign": null
        }
    }
}

]
API Calls
Get

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

Put

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

Get Facebook Plugin Configuration

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

Here,

  • pid

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

Edit Facebook Plugin Configuration

Description Guest Manager users with the Administrator role can access this API.
Syntax
PUT <Base_URL>/portals/{pid}/facebook/config

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/2/facebook/config
Request Body The API takes the plug-in configuration details to be updated as parameters in the request body.
The parameters are passed in the application/json format.
Response Body The API returns the details of Facebook plug-in configuration in the response body.
The response is in the application/json format.