Third Party Integrations

This provides details on how to send guest user information to a third party application. You can enable this under admin tab in the UI. Guest Manager can integrate with those third party applications and send the guest data to those applications. When the data is extracted, guest users get their share of offers or messages based on it.

JSON Table

Attribute	Data Type	Description	Default/Sample value
success	boolean	Specifies whether the API call is successful or not.	true
message	String	A message string indicating whether the API call is successful.	Record(s) Found
data	application/json	A JSON object including the third party integration data.
data/totalCount	int		3
data/endpoint	application/json
data/endpoint/id	int	ID of the third party endpoint.	1
data/endpoint/name	String	Name of the third party endpoint.	GET
data/endpoint/description	String	Description for the endpoint.	GET
data/endpoint/request_uri	String	Request URLl for the endpoint.	https://cdn-test.dt.airtightnw.com
data/endpoint/request_wait_time	int	Wait time to receive response from the thirdparty endpoint.	10
data/endpoint/request_method	String	Method used to make a request.	get
data/endpoint/active	int	It indicates whether endpoint is active or not. 1 indicates active endpoint.	1
data/endpoint/date_created	int	Creation date.	2017-09-11 05:46:00.055754
data/endpoint/date_modified		Last Modified Date	null
data/endpoint/request_format	application/json
data/endpoint/request_format/type	String	Type of field. Applicable values are: custom system	system
data/endpoint/request_format/key	String	Key used	Test
data/endpoint/request_format/value	String		portal_name

Sample JSON

{
    "success": true,
    "message": "Record(s) Found",
    "data": {
        "totalCount": 7,
        "endpoint": [
            {
                "id": 2,
                "name": "POST",
                "description": "POST",
                "request_uri": "https://cdn-test.dt.airtightnw.com",
                "request_wait_time": 10,
                "request_method": "post",
                "active": 1,
                "date_created": "2017-09-11 05:47:02.883965",
                "date_modified": null,
                "request_format": [
                    {
                        "type": "system",
                        "key": "Test",
                        "value": "username"
                    }
                ]
            },
            {
                "id": 3,
                "name": "REDIRECT",
                "description": "REDIRECT",
                "request_uri": "https://cdn-test.dt.airtightnw.com",
                "request_wait_time": 10,
                "request_method": "redirect",
                "active": 1,
                "date_created": "2017-09-11 05:47:58.274451",
                "date_modified": null,
                "request_format": [
                    {
                        "type": "system",
                        "key": "Test",
                        "value": "email"
                    }
                ]
            },
            {
                "id": 6,
                "name": "abc1",
                "description": "",
                "request_uri": "http://www.myendpoint.com",
                "request_wait_time": 10,
                "request_method": "get",
                "active": 1,
                "date_created": "2018-02-13 17:03:57.129641",
                "date_modified": null,
                "request_format": [
                    {
                        "type": "system",
                        "key": "12",
                        "value": "portal_name"
                    }
                ]
            },
            {
                "id": 8,
                "name": "abc",
                "description": "",
                "request_uri": "http://www.myendpoint.com",
                "request_wait_time": 10,
                "request_method": "post",
                "active": 1,
                "date_created": "2018-02-14 08:52:39.892102",
                "date_modified": "2018-02-14 08:52:55.375076",
                "request_format": [
                    {
                        "type": "system",
                        "key": "12",
                        "value": "portal_name"
                    }
                ]
            },
            {
                "id": 9,
                "name": "abc123",
                "description": "",
                "request_uri": "http://www.myendpoint.com",
                "request_wait_time": 10,
                "request_method": "post",
                "active": 1,
                "date_created": "2018-02-14 12:08:17.828638",
                "date_modified": "2018-02-14 12:08:40.567859",
                "request_format": [
                    {
                        "type": "system",
                        "key": "12",
                        "value": "portal_name"
                    }
                ]
            },
            {
                "id": 1,
                "name": "GET",
                "description": "GET",
                "request_uri": "https://cdn-test.dt.airtightnw.com",
                "request_wait_time": 10,
                "request_method": "get",
                "active": 1,
                "date_created": "2017-09-11 05:46:00.055754",
                "date_modified": "2018-02-15 07:12:48.370616",
                "request_format": [
                    {
                        "type": "system",
                        "key": "Test",
                        "value": "portal_name"
                    },
                    {
                        "type": "system",
                        "key": "abcd",
                        "value": "plugin_name"
                    }
                ]
            },
            {
                "id": 11,
                "name": "TP",
                "description": "Third Party Integrations",
                "request_uri": "https://marketverticalanalytics.airtightnw.com",
                "request_wait_time": 12,
                "request_method": "get",
                "active": 1,
                "date_created": "2018-02-15 12:35:49.884395",
                "date_modified": "2018-02-15 12:48:26.047741",
                "request_format": [
                    {
                        "type": "system",
                        "key": "Portal Name",
                        "value": "portal_name"
                    },
                    {
                        "type": "system",
                        "key": "Plugin Name",
                        "value": "plugin_name"
                    },
                    {
                        "type": "system",
                        "key": "Client MAC",
                        "value": "client_mac"
                    },
                    {
                        "type": "system",
                        "key": "Last Visit",
                        "value": "last_visit"
                    },
                    {
                        "type": "system",
                        "key": "Date Created",
                        "value": "date_created"
                    },
                    {
                        "type": "system",
                        "key": "Birth Year",
                        "value": "birth_year"
                    }
                ]
            }
        ]
    }
}

API Calls

Get

/v1.14/services/notification/endpoints

Post

/v1.14/services/notification/endpoints

Put

/v1.14/services/notification/endpoints/{id}

Delete

/v1.14/services/notification/endpoints

Get Third Party Integrations

Description	This API is used to retrieve configuration details of third party integration endpoint. Guest Manager users with the Administrator role can access this API.
Syntax	GET <Base_URL>/services/notification/endpoints?limit=<value> Here, limit
Sample code	GET https://analyticsdemo.mojonetworks.com/api/v1.14/services/notification/endpoints?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 details of third party integration endpoint.

Create Third Party Integrations

Description	This API is used to create a third party integration endpoint. Guest Manager users with the Administrator role can access this API.
Syntax	POST <Base_URL>/services/notification/endpoints
Sample code	POST https://analyticsdemo.mojonetworks.com/api/v1.14/services/notification/endpoints
Request Body	This API call requires the details of the third party integration endpoint, which is passed as parameters in the request body. The parameters are passed in the application/json format. Name, End Point URI, and Response Timeout are the mandatory fields.A sample request body is as follows: { "name": "TP", "description": "Third Party Integrations", "request_uri": "https://marketverticalanalytics.airtightnw.com", "request_wait_time": 10, "request_method": "get", "active": 1, "request_format": [{ "type": "system", "key": "Portal Name", "value": "portal_name" }, { "type": "system", "key": "Plugin Name", "value": "plugin_name" }, { "type": "system", "key": "Client MAC", "value": "client_mac" }, { "type": "system", "key": "Last Visit", "value": "last_visit" }, { "type": "system", "key": "Date Created", "value": "date_created" }] }
Response Body	If the API call is successful, the HTTP response status is 200. The response body contains the details of the newly created third-party integration endpoint.

Edit Third Party Integrations

Description	This API is used to edit existing, third party integration endpoint configuration. Guest Manager users with the Administrator role can access this API.
Syntax	PUT <Base_URL>/services/notification/endpoints/{id} Here, id Id is the parameter which helps to identify which third party integration parameter to edit.
Sample code	PUT https://analyticsdemo.mojonetworks.com/api/v1.14/services/notification/endpoints/11
Request Body	This API call requires the details of the third party integration endpoint that is to be updated. The parameters are passed in the application/json format. Request format attributes like AP MAC, AP SSID, Username, First Name, Last Name, etc can also be added.A sample request body is as follows: { "name": "TP", "description": "Third Party Integrations", "request_uri": "https://marketverticalanalytics.airtightnw.com", "request_wait_time": 12, "request_method": "get", "active": 1, "request_format": [{ "type": "system", "key": "Portal Name", "value": "portal_name" }, { "type": "system", "key": "Plugin Name", "value": "plugin_name" }, { "type": "system", "key": "Client MAC", "value": "client_mac" }, { "type": "system", "key": "Last Visit", "value": "last_visit" }, { "type": "system", "key": "Date Created", "value": "date_created" },{ "type": "system", "key": "Birth Year", "value": "birth_year" } ] }
Response Body	If the API call is successful, the HTTP response status is 200. The response body contains the details of the recently edited third party integration endpoint.

Delete Third-Party Integrations

Description	This API is used to create a third party integration endpoint. Guest Manager users with the Administrator role can access this API.
Syntax	DELETE <Base_URL>/services/notification/endpoints{id} Here, id Id is the parameter which helps to identify which third party integration parameter to delete.
Sample code	https://analyticsdemo.mojonetworks.com/api/v1.14/services/notification/endpoints/4
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 the details of the recently deleted third-party integration endpoint.

Understand Arista Cloud Architecture

Know what Arista APIs can do

Know how Arista APIs work?

API Reference

Third Party Integrations