plug-in_configuration

Twitter Plugin Configuration

A Twitter 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 Twitter plug-in. You can view all the configuration details for the Twitter 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 Twitter plugin-> Settings tab-> plugin configuration -> Twitter 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 Manadatory Default/Sample Value
client_id String The Client ID for the Twitter app configured on the Twitter plug-in. No key_123456jhgrtty
client_secret String The client secret for the Twitter app configured on the Twitter plug-in. No secret_sdkfjiouiueryy
follow_page String The Twitter follow page URL configured on the Twitter plug-in. No http://www.twitter.com/ company/ followPage
follow_page_display int Whether the Twitter follow page must be displayed to the guest user or not. No 1
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. No 60
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. No 10
landing_url String The URL of the page to which the guest user is redirected to on successful login using this plug-in. No http://www.google.com
bandwidth_upload_limit int Maximum upload bandwidth, in Kbps, for the guest user accounts. No 128
bandwidth_download_limit int Maximum download bandwidth, in Kbps, for the guest user accounts. No 256

Copy Sample JSON
Sample JSON 
[

{
    "success": true,
    "message": "Record Found",
    "data": {
        "totalCount": 1,
        "twConfig": {
            "pid": 6,
            "consumer_key": null,
            "consumer_secret": null,
            "follow_page": null,
            "follow_page_display": 0,
            "date_created": "2017-09-12 09:25:12.243072",
            "session_timeout": null,
            "blackout_time": null,
            "date_modified": "2018-02-01 13:10:31.655334",
            "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",
            "campaign": null
        }
    }
}

]
API Calls
Get

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

Put

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

Get Twitter Plugin Configuration

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

Here,

  • pid

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

Edit Twitter Plugin Configuration

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

Here,

  • pid

    It is the unique ID of the portal for which the Twitter plug-in configuration has to be updated.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/6/twitter/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 Twitter plug-in configuration in the response body.
The response is in the application/json format.