Admin Console
Number of APIs: 7
BluePort Vault is an authentication backend and a Wi-Fi key store used to enable Globally Unique Wi-Fi WPA2 Passphrases for Internet subscribers.
Vault enables single SSID networks for large residential communities with property-wide roaming (yes, even the ones with thousands of residents - and yes, across properties), centralizes key distribution for both large scale enterprise and consumer networks, provides each subscriber with their own encypted key and secures the Wi-Fi transmission. Vault enables Managed Wi-Fi platforms providers to provide multi-venue Wi-Fi services to their customers. ISPs, network operators, and businesses can futher provide Wi-Fi as a service to their members and patrons, using additional Vault services offered through their Managed Wi-Fi platform provider. Whew!
Documentation NOTE: All the API calls for Network Software Providers (this document) will be listed at this URL: https://documenter.getQodex.com/view/10711528/2s9YR6ZtTL
ONBOARDING GUIDE FOR NETWORK SOFTWARE PROVIDERS
To consume the following APIs, you will also need an API key from the Vault administrators. Set the API key in header "x-api-key" of API calls.
Step 1 - Add a new Network Operator
- As a Network Software Provider, call
/networksoftwareprovider/listNetworkOperators
to get a list of all Network Operators. You cannot see Network Operators of other Network Software Providers. - Add a new Network Operator with
/networksoftwareprovider/addNetworkOperator
. You will need at least oneNAS-IP-Address
for the Network Operator's Wi-Fi controller.
Step 2 - Connect Network Operator to a Property Management Group
- This is a manual step for now. Provide Network Operator and Property Management Group details to VAULT Admins to connect them, and make their assets visible to each other.
Step 3 - View available Venues across Property Management Groups
- Call
/networkoperator/propertymanagement/listAvailableVenues
to get a list of venues available across all Property Management Groups.
Step 4 - Provide Wi-Fi infrastructure at a venue
- Call
/networkoperator/propertymanagement/requestVenueAccessfromPropertyManagement
to request venue access for providing Wi-Fi service at their venue. Property Management Groups can use their API/propertymanagement/networkoperator/assignVenuetoNetworkOperator
to authorize Network Operator's request. You will need to provideNAS-Identifier
for the venue
Step 5 - View serviced venues
- Call
/networkoperator/propertymanagement/listServicedVenues
to get a list of venues serviced across all Property Management Groups.
Step 6 - Configure Wi-Fi controller
- Set up the Wi-Fi controller for external DPSK RADIUS authentication with
NAS-IP-Address
as set in Step 1 andNAS-Identifier
as set in Step 4.
Property Management Group's subscribers can now connect to Wi-Fi from a venue using Network Operator's Wi-Fi infrastructure.
SSIDs and subscribers are managed by Property Management Group in this case.
- Set up your RADIUS server to call Vault API
/authticate/getRuckusPSK()
on behalf of Wi-Fi controller.
Step 7 (Optional) - Network Operator's SSID and subscribers
- Network Operators can also request their SSIDs / key pools to be authenticated at a venue.
- To request Property Management Group to broadcast your SSID, call
/networkoperator/propertymanagement/requestKeypoolAuthorizationatVenue
. Property Management Group can use their API/propertymanagement/authorizeKeyPoolatVenue
to authorize Network Operator's request.
Network Operator's subscribers can now connect to Wi-Fi from a venue using Network Operator's Wi-Fi infrastructure.
SSIDs and subscribers are managed by Network Operators in this case.
Step 8 - Add a subscriber
- Call
/networkoperator/subscribers/addSubscriber
to add a new subscriber account. - Note the returned SubscriberToken. You should attach the SubscriberToken to each subscriber account in your system. (e.g. loyalty memebership number or customer's email address).
- For PII purposes, Vault does not require any other identifier for your subscriber account other than the SubscriberToken.
- Each subscriberToken can have multiple keys (Wi-Fi WPA2 PSK) attached to their account.
- To get a list of new SubscriberTokens that do not have a key attached, call
/networkoperator/subscribers/listUnusedSubscriberTokens
. You cannot have more than 5 unused unused SubscriberTokens.
Step 9 - Add a key
- Call
/networkoperator/subscribers/addKey
to add a key (e.g. Wi-Fi WPA2 PSK) for a subscriberToken. - Call
/networkoperator/listKeypools
to view updated list of subscribers for associated KeypoolID - You can only add keys to keypools that you own.
- Call
/networkoperator/listVenues
to view updated list of network policies for associated VenueID - You can only add keys to keypools that you own.
Network Policies
- Network Operators can add network policies to venues of property managers.
*Step 10 - Authenticate a device (using Ruckus external DPSK) *
- Configure your Wi-Fi controller for external DPSK using RADIUS
- Set up your RADIUS server to call
/deviceauthenticator/RukcusDPSK
-
venue - modifyVenueOperator POST {{url}}/adminconsole/venue/modifyVenueOperator
-
esim - add POST {{url}}/adminconsole/esim/add
-
esim - getESIM POST {{url}}/publiconsole/getESIM
-
utils - getCachedItem POST {{url}}/adminconsole/utils/getCachedItem
-
utils - refreshCache POST {{url}}/adminconsole/utils/refreshCache
-
utils - release notification POST {{url}}/operatorconsole/subscribers/sendEmail
-
pmg - listPropertyManagementGroups POST {{url}}/adminconsole/listPropertyManagementGroups