The API developer portal is a documentation environment that allows any developer to easily find, understand and use our APIs. You can find it at https://dev.cloud4wi.com/ or go there by clicking on the API documentation button in the "Cloud4Wi API" application, in the Marketplace.
By entering your "API key" / API secret" pair you can access a developer-friendly environment, where you can find a list of all supported API endpoints. For each endpoint, you can find a list of supported parameters, with their type and description.
The environment also allows you to generate your request by filling out a web form. As a result of your request, the REST URL, along with the results of your real data will be generated.
Please note that currently we only support the GET method. This means that you can easily check all your API callbacks by entering your REST URL in the navigation bar of your browser.
In order yo use this developer portal you need to enter your API secret. If you don't have an API secret or you don't understand what this means, please read the following article: Get or refresh your API credentials through the Admin Panel.
Entering your API key/secret
Please access the API documentation environment at https://dev.cloud4wi.com/ and enter your API key and secret. Then a list of endpoints appears and you can easy make requests, get responses and understand how our API work. Below you can find an example of usage.
Example of usage: Users
We assume that API key and secret have been entered.
In this example we're using API version 2.0. You can select the version in the drop-down menu at the top-right corner of the page.
API endpoints are divided into categories.
In our case, we choose to perform operations on users and we click on "Users : Retrieve all end-user's profiles and details" to expand this section.
Then we can see more information on that, such as the HTTP method (in this case "GET"), some short implementation notes, the response content type ("application/json" in all current cases), the parameters and the response messages.
In this example, we are choosing the "/users" endpoint and click on the corresponding "GET" label.
In the parameters list, required fields are filled with default values. By clicking on the Try it out! button, you can get the API callback for the selected values (deleted, limit, offset).
Please note that the following data are shown:
- Request URL
- Response body
- Response code
- Response headers
This data is usually helpful for you to manage all possible cases. You can copy and paste the Request URL to your code, to be sure that the API call on your code is the same made in the documentation environment.
In our case the request URL is:
Now we can get a subset of the users who returned. We can get a list of active users with a Click-Through account that accepted the marketing clause. This means:
- provider: 'passthrough'
- privacy: true
- deleted: false
- showUsersDesc: true
- limit: 1000
- offset: 0
After filling out the form and clicking on the Try it out! button, you can get your response again. In this case, the URL of the request is:
This is a very intuitive way to make API calls, and no advanced development skills are required. It is helpful to have a good knowledge of Volare, to be fully aware of all the necessary steps.
Now you are ready to write your own code. Find a sample script in the following article: Examples of custom code using APIs.