plug-in_configuration

Instagram Plug-In Configuration

Users can configure Instagram plug-ins on captive portal. A user  must have the Administrator role to configure the Instagram plug-ins. Before configuring the Instagram plug-in one must ensure that you have created your application/ project in the social media.

JSON Table

Attribute Data Type Description Default/Sample value
success boolean true
message String Record Found
data application/json
data/totalCount int 1
data/instagramConfig
data/instagramConfig/pid int 8
data/instagramConfig/client_id
data/instagramConfig/client_secret
data/instagramConfig/session_timeout
data/instagramConfig/blackout_time
data/instagramConfig/bandwidth_upload_limit
data/instagramConfig/bandwidth_download_limit
data/instagramConfig/redirect_landing_url
data/instagramConfig/redirect_endpoint_id
data/instagramConfig/date_created int 2017-09-12 10:49:16.618339
data/instagramConfig/date_modified int 2018-02-07 07:34:41.607583
data/instagramConfig/redirect_campaign_id
data/instagramConfig/redirect_type String redirect_landing_url
data/instagramConfig/callback_url String https://marketverticalanalytics.airtightnw.com/plugin/instagram/auth
data/instagramConfig/campaign

Copy Sample JSON
Sample JSON 
{
    "success": true,
    "message": "Record Found",
    "data": {
        "totalCount": 1,
        "instagramConfig": {
            "pid": 8,
            "client_id": null,
            "client_secret": "",
            "session_timeout": null,
            "blackout_time": null,
            "bandwidth_upload_limit": null,
            "bandwidth_download_limit": null,
            "redirect_landing_url": null,
            "redirect_endpoint_id": null,
            "date_created": "2017-09-12 10:49:16.618339",
            "date_modified": "2018-02-15 15:01:04.308786",
            "redirect_campaign_id": null,
            "redirect_type": "redirect_landing_url",
            "callback_url": "https://marketverticalanalytics.airtightnw.com/plugin/instagram/auth",
            "campaign": null
        }
    }
}
API Calls
Get

/v1.14/portals/{portal_id}/instagram/config

Put

/v1.14/portals/{portal_id}/instagram/config

Get Instagram Plugin Configuration

Description Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/portals/{portal_id}/instagram/config?limit=<value>

Here,

  • limit
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/portals/8/instagram/config?limit=5000
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains configuration details for instagram.

Edit Instagram Plugin Configuration

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

Here,

  • portal_id

    It is the unique system-generated ID of the portal whose details are to be edited. It takes an integer value.

 
Sample code
PUT https://analyticsdemo.mojonetworks.com/api/v1.14/portals/8/instagram/config
Request Body A sample request body is as follows:

{
	"client_id": null,
	"client_secret": "",
	"session_timeout": null,
	"blackout_time": null,
	"bandwidth_upload_limit": null,
	"bandwidth_download_limit": null,
	"redirect_landing_url": null,
	"redirect_endpoint_id": null,
	"redirect_campaign_id": null,
	"redirect_type": "redirect_landing_url"
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains configuration details for instagram.