Cloud4Wi APIs Overview

The Cloud4Wi REST APIs allow you to query meta-data about your accounts, end-users, Hotspots, Location, accounting logs, Splash Page 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.

At this time we are transitioning from V2 to V3. APIs V3 are stable and functional. Not all end-points are available at this time, but we are rolling out new method every week. We suggest to consider using APIs V3 for every new project.


Using the right navigation menu, you can find the following info:



APIs usage guidelines


The Cloud4Wi public endpoints are powered by the same underlying technology that powers the core Cloud4Wi application. As a result, Cloud4Wi engineering closely monitors the usage of the public APIs to ensure a quality experience for users of the Cloud4Wi applications.

All integrations must comply with the Cloud4Wi Terms of Use and API Terms of Use. Please see these pages for more details:

Moreover, the APIs have rate and volume limits depending on your Cloud4Wi subscription.


Splash

Usage of APIs is subject to our fair usage policy of 2000 Objects/Month per Subscription (per Access Point). Objects include any type of record exchanged via APIs or webhooks, including Users, Logs, Location and Access Points. API endpoints that retrieve aggregated analytics and metrics counts as a single object.

For example, a customer with 100 Splash Subscription would be allowed 200,000 objects per month.

The volume of transferred objects will be monitored on a monthly basis. If Clients exceed this allowance in the previous month, they can purchase additional Overage Subscriptions to extend the overall limit of max objects/month. If they do not extend their allowance, a hard threshold on the API volume will be enforced.

On top of the limit above, Cloud4Wi impose a generic burst rate limit of 60 hits / 60 seconds on all the REST APIs.


Compass

Usage of APIs is subject to our fair usage policy of 10 Objects/Month per Contact. Objects include any type of record exchanged via APIs or webhooks, including Contact Profile, Event Log, Location and Access Points. API endpoints that retrieve aggregated analytics and metrics counts as a single object for each API hit.

The volume of transferred objects will be monitored on a monthly basis. If Clients exceed this allowance in the previous month, they can purchase additional Overage Subscriptions to extend the overall limit of max objects/month. If they do not extend the allowance, a hard threshold on the API volume will be enforced.

On top of the limit above, Cloud4Wi impose a generic burst rate limit of 60 hits / 60 seconds on all the REST APIs.