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 get your API credentials by accessing the "Cloud4Wi API" page form the Marketplace section of the Admin Panel. The API key identifies a Tenant and cannot be changed. You can, however, change your API secret at any time by clicking on the Renew API Secret button in the "Cloud4Wi API" page. The API secret is a secret shared between Cloud4Wi and your application and for this reason, it must not be public in any case.
Data scrolling and pagination
When you deal with a large number of records, you need to retrieve smaller chunks of data with multiple API calls.
Most of the API endpoints use the pagination method to move across multiple chunks of records, using the limit and offset parameters. The limit parameter determines the maximum number of records returned in a single API call. The offset parameter indicates the index of the first records to be retrieved.
Some API endpoints are designed to provide access to the data at a faster speed. This method requires you to use the ScrollId parameter, and it is available in the following endpoints:
Each ScrollId token value has an expiration set to 2 minutes and each API iteration can retrieve up to 9.999 records.
Some API endpoints (/connections and /troubleshooting) provide both methods while managing the transition from the standard pagination technique to the ScrollId.
If you are already using the APIs with the standard pagination technique, you can keep using it by using limit and offset parameter and omitting the scollId parameter.
Whenever you want to migrate to the ScrollId method, you can simply start using the ScrollId token in the API call (offset and limit values won't be considered in this case).
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|