As part of the Property management feature, RUCKUS One administrators can create units for each Venue. The Resident Portal APIs enable the unit resident to manage their own devices, DPSKs, and guest access, and their contact information.
The Resident Portal APIs, categorized under API Group "Resident Portal" offer access to device and owner information for a single unit, as defined and created in the Venue Property Management Feature. These APIs serve as a foundation for creating a custom Resident Portal. Both the Resident Portal and the Resident Portal APIs can be disabled with the RUCKUS One UI, or through the Property Configuration APIs, "Selectively Update Property Configuration".
Authentication to the resident portal are provided by a unique key associated to the unit and not the administrative credentials. Consequently, the API provides information and limited control only of aspects respective of the unit. Both the Administrator and the Resident Portal APIs can be used to reset the unique key linked to a particular unit.
Login into the API per Unit. ETo access the Resident portal, APIs on a per unit bases, you will utilize the specific unique key associated to the unit. To initiate this process, make use of the "Resident Portal Login API". This API will return a JSON Web Token (JWT) that will be used in subsequent Resident Portal API calls. The following API groups can be accessed by this mechanism:
- Resident Portal Login API: The login APIs.
- Resident Portal Configuration: Provides details for the venue that can be presented to the unit owner.
- Resident Portal Unit API: Provides unit specific details and allows management of certain properties.
- Resident Portal UI Configuration: Provides details on the resident portal UI configuration, like logo, and title information.