1. Home
  2. Knowledge Base
  3. FAQs
  4. How To?
  5. Marketing4WiFi API Endpoints

Marketing4WiFi API Endpoints

  1. All requests to the API require your SmartWiFi API Token.
  2. All requests are done via HTTPS and depending on the environment will use one of the following hostnames.
    You can confirm your environment under Operator Customizations.
    US-A Environment
    api.smartwifiplatform.com
    B
    api-usb.smartwifiplatform.com
  3. All responses contain JSON.

GET Clients

Path: /v2/zapier/dropdown/clients
Description: Returns a list of clients associated with the Operator API token.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/dropdown/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'

Example response: 

[ 
    { 
        "id"12734, 
        "company""ExampleCompany1" 
    }, 
    { 
        "id"15343, 
        "company""ExampleCompany2" 
    }, 
    { 
        "id"19648, 
        "company""ExampleCompany3" 
    } 
] 

GET Client Details

Path: /v2/zapier/clients
Description: Returns a list of clients associated with the operator
api token, billing system id, and admin contact information.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'

Example response: 

[ 
    { 
        "id"12734, 
        "company""ExampleCompany1", 
        "billing_system_id"26565, 
        "admin_contact_name"TestAdmin, 
        "admin_contact_email"testadmin@email.com, 
        "admin_contact_phone"1234567890 
    }, 
    { 
        "id"15343, 
        "company""ExampleCompany2", 
        "billing_system_id"26566, 
        "admin_contact_name"TestAdmin, 
        "admin_contact_email"testadmin@email.com, 
        "admin_contact_phone"1234567890 
    }, 
    { 
        "id"19648, 
        "company""ExampleCompany3", 
        "billing_system_id"26567, 
        "admin_contact_name"TestAdmin, 
        "admin_contact_email"testadmin@email.com, 
        "admin_contact_phone"1234567890 
    } 
] 

GET Hotspots

Path: /v2/zapier/hotspots
Description: Returns a list of
hotspots associated with the operator api token, the client it is assign to, and the category it belongs in.
Example request:

curl --location --request GET 'https://api.smartwifiplatform.com/v2/zapier/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
}'

Example response: 

[ 
    { 
        "id"24115, 
        "name""TestHotspot", 
        "address""123 Test st.", 
        "nasidentifier""XXXX", 
        "venuename""test", 
        "phone"1234567890, 
        "city""TestCity", 
        "state""TestState", 
        "postal_code""90210", 
        "country"TestCountry, 
        "lat"null, 
        "long"null, 
        "enabled"true, 
        "client": { 
            "id"12734, 
            "company""ExampleCompany1", 
            "billing_system_id"26565, 
            "admin_contact_name"TestAdmin, 
            "admin_contact_email"testadmin@email.com, 
            "admin_contact_phone"1234567890 
        }, 
        "categories": [ 
            { 
                "id"1, 
                "label""Airport" 
            } 
        ] 
    } 
] 

GET Available Plans

Path: /v3/clients/plans
Description: Returns a list of
the plan templates associated with the Operator dashboard.
Example request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/clients/plans' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1" }'

Example response:

[
    {
        "id": 20,
        "plan": "Bronze"
    },
    {
        "id": 28,
        "plan": "Silver"
    },
    {
        "id": 27,
        "plan": "Gold"
    },
    {
        "id": 29,
        "plan": "Enterprise"
    }
]

POST Create Client

Path: /v3/clients
Description: Creates a Client in the Operator dashboard.
Example Request:

curl --location --request POST 'https://api.smartwifiplatform.com/v2/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
   "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
    "billing_ID": "2xx9",
    "company": "My Company",
    "template": 5
}'

Example response:

{
    "client_id": "2x1"
}

PUT Suspend Client

Path: /v3/clients/suspend
Description: Suspends a Client in the Operator dashboard.
Example Request:

curl --location --request PUT 'https://api.smartwifiplatform.com/v3/clients/suspend' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
   "client_id": 2x1 }'

Example response:

{
    "client_id": "2x1",
    "client_status": "suspended"
}

PUT Unsuspend Client

Path: /v3/clients/suspend
Description: Activate a suspended Client in the Operator dashboard.
Example Request:

curl --location --request PUT 'https://api.smartwifiplatform.com/v3/clients/unsuspend' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
    "client_id": 2x1 }'

Example response:

{
    "client_id": "2x1",    "client_status": "active" }

POST Client User

Path: /v3/clientusers
Description: Create a Client user in the Operator dashboard.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/clients/id' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1",
   "client_id": 2x1, "username": "DemoUser", "password": "GuestPassword", "email": "demo@example.com", "template": 5 }'

Example response:

{
"client_user_id": "1x9",
}

GET Client ID

Path: /v3/clients/id
Description: Returns the Client ID of a Client based on their billing ID.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/clients/id' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "billing_id": 2xx9 }'

Example response:

{
    "client_id": "2x1"
}

GET Hotspots

Path: /v3/hotspots
Description: Returns a list of hotspot IDs and their name.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
   "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "client_id": 2x1 }'

Example response:

[
    {
        "id": 3x0,
        "name": "Demo Hotspot"
    }
]

POST Create Hotspot

Path: /v3/hotspots
Description: Create a hotspot under the specified Client.
Example Request:

curl --location --request POST 'https://api.smartwifiplatform.com/v3/hotspots' \
--header 'Content-Type: application/json' \
--data-raw '{
   "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86",
    "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "client_id": 2x1, "name": "Demo Hotspot", "venue": "My Venue", "address": "Address", "city": "city", "state": "state", "zipcode": "zipcode", "country": "country", "phone": "phone", "redirect_url": "https://google.com", "nasid": "gwCtosroY", "nas_secret": "gwCtosroY" }'

Example response:

{
    "hotspot_id": "3x0"
}

PUT Enable Hotspot

Path: /v3/hotspots/enable
Description: Enable a hotspot under the specified Client.
Example Request:

curl --location --request PUT 'https://devapi.smartwifiplatform.com/v3/hotspots/enable' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "client_id": 2x1, "hotspot_id": 3x0 }'

Example response:

{
    "hotspot_id": "3x0",
    "hotspot_status": "enabled"
}

GET Controller Types

Path: /v3/controllerTypes
Description: Returns the current list of controller types and their ID.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/controllerTypes' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1" }'

Example response:

{
    "id": "5",
    "name": "Ruckus SCG & vSZ"
}

GET Controllers

Path: /v3/controllers
Description: Returns the list of Gateways under a specified client hotspot.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/controllers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "client_id": 1x7, "hotspot_id": 2x2 }'

Example response:

[
    {
        "id": 22965,
        "name": "Demo Gateway",
        "macaddress": "7x:4x:2x:Dx:0x:Cx"
    },
]

GET Client Usage


Path: /v3/client_usage
Description: Returns the usage data for the specified Client.
Example Request:

curl --location --request GET 'https://api.smartwifiplatform.com/v3/client_usage' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "52d7XXXX-XXXX-XXXX-XXXX-XXXXXXXXff86", "secret": "50beXXXX-XXXX-XXXX-XXXX-XXXXXXXXa9a1", "client_id": 1x7, "month": 11, "year": 2022 }'

Example response:

[
    {
        "month": 11,
        "year": 2022,
        "client_id": 1x7,
        "guests": 26,
        "sessions": 52,
        "sms_sent": 0,
        "smart_campaigns": 181,
        "scheduled_campaigns": 27,
        "contacts": 260787,
        "hotspots": 0,
        "new_hotspots": 0,
        "controllers": 0,
        "new_controllers": 0,
        "guest_plans": 0,
        "transactions": 0,
        "create_date": "2022-12-27T19:56:07.651958+00:00",
        "last_modifed": null
    }
]

Updated on January 5, 2023

Was this article helpful?

Related Articles

Need Support?
Can't find the answer you're looking for? Don't worry we're here to help!
CONTACT SUPPORT