Integrating the SDK
Last updated
Last updated
The SDKs provide a few basic methods that ultimately allow provisioning the user device with a WiFi profile. There are two main steps to provision a WiFi profile using the SDK:
To authenticate the SDK and connect it to your Cloud4Wi account, you need to generate an API key and API secret.
In the Cloud4Wi dashboard, go to Developers and select the WiFi SDK tab. Click the button New Mobile Add. The app Project dialog appears.
Enter a reference name for your app project. Enter the Android Package Name and iOS Bundle ID.
Enter the name of the SSID that must match the one used in the WiFi network. Leave Hidden SSID unchecked.
In the Passpoint section, enter your Domain Name, such as <company_name>.securewifi.io. In the Operator Friendly Name enter a value that identifies your company for the end users, such as "Secure WiFI by Company".
Check "Add the "Settlement-Free" RCOI to Passpoint profiles" if you want your mobile app users to be able to connect automatically to the WiFi of millions of settlement-free access points around the world from the OpenRoaming federation.
Click Save to return to the main table. Copy the API Key and API Secret in the SDK Credentials column of the app you just created.
A User must be created on the Cloud4Wi systems before creating and installing a WiFi Profile.
Users can be initialized with attributes and identifiers that allow the reconciliation of the user data with external systems, including CRMs, CDPs, and marketing automation tools. This includes email address, phone number, or any external identifiers known to the mobile app (check the Customer object for iOS and Android for the full list of attributes).
Cloud4Wi suggests passing at least a recognizable identifier to allow an easier reconciliation of the User records in Cloud4Wi with the related records in other systems, such as an external id or email address.
The user can be initialized by passing a specific username and password generated by the mobile app. If not provided in the initialization, Cloud4Wi generates random network credentials associated with the user, which will then be used to generate either Passpoint or WPA2 Enterprise Wireless Profiles.
Cloud4Wi allows configuring specific data processing rules in the account configuration that process each individual user's data based on the consent fields set on its record. Coud4Wi allows to create any custom consent fields from the dashboard, but it comes with 3 pre-configured consents:
Privacy Policy
Terms of Service
Marketing
The Terms of Service (termsOfUse)and Privacy Policy (privacy)consents are mandatory to be set to true whenever a customer is added via APIs or via the mobile SDKs.
The Marketing consent is an optional, pre-defined field that can be set to record consent to receive promotional marketing communications. The same purpose can be achieved using custom fields if necessary.
To retrieve the custom consents, if needed, you can use the dedicated methods (getListOfPolicies)
The SDK method to initialize the user also requires setting the profiling parameter that determines whether the customer could be "profiled' or not. The Profiling processing activity processes and stores the customer visit history and computes personalized behavioral attributes.
The user can be initialized at any time by the app, for example contextually with the app sign-up process (if any), or right before triggering the WiFi Profile installation.
Android
createCustomeriOS
createCustomerWiFi Profiles are configuration files, specific to each operative system, that allow a device to connect and authenticate on a WiFi network. The method to install the WiFi Profile takes as input the network credentials generated in the previous step.
When the method to install the WiFi Profile is invoked, the Operative System prompts an alert to the user to ask for permission/confirmation (see user experience).
Cloud4Wi SDK provides two types of authentication methods:
WPA2 Enterprise
Passpoint
Read the Overview to learn more about the differences between WPA2 Enterprise and Passpoint.
Android
createWPA2EnterpriseProfilecreatePasspointProfileiOS
createWPA2EnterpriseProfilecreatePasspointProfile
