The Cloud4Wi REST APIs allow you to query meta-data about your accounts, end-users, Hotspots, Venues, accounting logs, Splash Portal impressions, Analytics data etc. .
Since the API is based on REST principles, it's very easy to write and test applications. You can use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API.
This section provides all the basic information you need to use Cloud4Wi REST APIs.
If you are getting started, then you have to follow the workflow below:
|Get your API Secret.
Open the "Cloud4Wi API" application, ask for the API secret and agree to terms and conditions for the service.
Access the Developer Portal
Cloud4Wi REST APIs are based on REST principles, so you can easily interact with them regardless of the language you use.
Getting your API secret
Please note that in order to interact with the Cloud4Wi REST APIs, it is necessary to have an "API key" / "API Secret" pair.
You can manage your API data by using the "Cloud4Wi API" application. You can start the application by clicking on the Marketplace button in the quick access toolbar and then finding the "Cloud4Wi API" application on the Marketplace.
The API key identifies a Tenant. Please keep in mind that this detail cannot be changed. The API secret is a secret shared between Cloud4Wi and your application and for this reason, it must not be public in any case.
You will not be able to change your API key. You can, however, change your API secret at any time, as explained in the next paragraph.
If you are starting the application for the first time, then you have your API key but you need to create your API secret.
Refreshing your API secret
You can refresh your API secret at any time, by clicking on the Renew API Secret button in the "Cloud4Wi API" application, in the Marketplace.
Please check out our sample scripts.
|Returns a CSV file with all active users on the Organization (API v1)||PHP 5||Download|
|Returns a CSV file with all active users on the Organization (API v2)||PHP 5||Download|