As an introduction to the Wi-Fi API endpoints, a basic workflow to install and configure a Wi-Fi network is described. The order of the following steps is merely an example. The following description is not meant to be comprehensive; rather, it is meant to be a guide to get you started with API client development.
- Create a venue for your APs. You can create as many venues as you like. Typically, one venue is created for each building in which you install APs. Or you can use a single "venue" for all the buildings on a campus; alternatively, a "venue" may be just a single floor in a multistory building, or an outdoor park.
- Provision your APs. To provision an AP, add the AP using the "Add APs" endpoint found in the AP section. Once your APs are provisioned, physically install them. They will automatically contact and join RUCKUS One. You can physically install your APs prior to provisioning, but they will not join the network until provisioned. In order to install an AP, your account must possess activated licenses. Purchased licenses are activated on the RUCKUS Support website. Use endpoints found under the Entitlements group to manage your entitlements (aka licenses). If you do not have any activated entitlements, the "Add APs" endpoint will return an error response.
- Verify your APs have connected to RUCKUS One. To check an AP's connection, use the "Get APs" endpoint in the "AP" API group. The API response provides the AP's connection status. If your APs are having trouble connecting, you can locally log in to your AP and use its troubleshooting utilities to diagnose the problem.
- Create a WLAN. Use the endpoints in the "Network" API group to create a WLAN. Note that WLANs are global resources that can be activated in as many venues as you like. Simply creating a WLAN does not deploy it to APs. To deploy the WLAN, it must be "activated" on a venue. Use the endpoints in the "Network-Venue" API group for managing WLAN deployments.
- Customize the configuration of your APs. AP configuration can be customized on three different levels:
- All the APs in a venue can be collectively customized using endpoints in the "AP-Venue" API group. On a per-venue basis, you can customize the radio or LAN port settings of your APs, as well as enable and manage mesh networking.
- APs can be grouped together using endpoints in the "AP" Group APIs. Each venue can have one or more AP groups; if you do not explicitly configure AP groups, all APs in a venue are members of the "default" group. Grouping APs is typically done to restrict the deployment of certain WLANs to the APs in a group rather than all the APs in a venue. You may want to do this, for example, to enable only your guest WLAN in the lobby of your venue. Also, using AP groups, WLANs can be enabled on either the 2.4-GHz or 5-GHz band instead of both bands (which is the default). Use the endpoints in the "Network-Venue" API group for managing WLAN (network) assignments to AP groups.
- APs can be individually customized using endpoints in the "AP" API group. On a per-AP basis, you can customize an AP's radio or LAN port settings. Individual AP configurations override group-level and venue-level configurations.
- Protect your network. Enable rogue AP detection, configure rogue AP classification policies, and view reports on detected rogue APs. Use the endpoints in the "AP-Venue" API group for this purpose. Note: Once an administrator is informed of the presence of a rogue AP, they can take steps to manually remove it.
- Add sophistication to your WLAN. Use the endpoints in the "L2ACL Policy", "L3ACL Policy", "Device Policy", and "Application Policy" API groups to create and manage WLAN policies that manage your wireless clients (end-user devices) and their connections to online services more effectively.
- Add new services to your wireless network. Services such as Wi-Fi calling and RUCKUS Location Services (aka vSPoT) are available; they can be configured and managed using the endpoints in their respective API groups. APs can provide DHCP service with sufficient scale for small offices or branch offices; use the endpoints in the "DHCP Configuration Service Profile" to configure the service and endpoints in "Update DHCP Service Profile Settings of This Venue" to activate them on your venues.
- Manage your network's client devices. If you have a guest WLAN that uses guest passes, you can create and manage guest users with endpoints in the "Guest User" API group. If you find client devices that should not be on your network, you can disconnect them using an endpoint in the "Clients Control" API.