API (v2) overview
The APIs V2 is maintained only for all customers with active integrations. All new interactions must use APIs V3. Cloud4Wi won't provide support, extension or software changes to APIs V2 starting September 2020.
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 Cloud4Wi Dashboard. 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.
The endpoints of the APis v2 can be explored here.
In order to explore the end points, you need a valid API Key and Secret as described in the step above.
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).