If you would like to retrieve information from the Smart WiFi Platform dashboard without utilizing one of the platforms integrations you have the choice to make your own requests to the Smart WiFi Platform API endpoints.This article references the v2 API.
Please remember the following when working with the SmartWiFi API endpoints.
- All requests to the v2 API require your SmartWiFi API Token.
- All requests are done via HTTPS and depending on the environment will use one of the following hostnames.US-A Environmentapi.smartwifiplatform.comBapi-usb.smartwifiplatform.com
- All responses contain JSON.
Available Endpoints
- /v2/zapier/dropdown/clients?api_token=<api-token>
Description: Returns a list of clients associated with the operator api token.
Example: https://api.smartwifiplatform.com/v2/zapier/dropdown/clients?api_token=<api-token>
Example response:
[ { "id": 12734, "company": "ExampleCompany1" }, { "id": 15343, "company": "ExampleCompany2" }, { "id": 19648, "company": "ExampleCompany3" } ]
- /v2/zapier/clients?api_token=<api-token>
Description: Returns a list of clients associated with the operator api token, billing system id, and admin contact information.
Example:https://api.smartwifiplatform.com/v2/zapier/clients?api_token=<api-token>
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 } ]
- /v2/zapier/hotspots?api_token=<api-token>
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:
https://api.smartwifiplatform.com/v2/zapier/hotspots?api_token=<api-token>
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" } ] } ]