Prerequisites
The accounts, keys, and project setup you need before your first heliumOS Wi-Fi offload call.
1. Partner account
Your organization needs a partner record before any API call will succeed. The record holds:
- Your partner ID (a UUID), used in every admin endpoint path like
/partners/{partner_id}/.... - One or more email domains you own (for example
acme-mobile.com), used to route admin sign-ins. - Optional preset configuration defining the EAP type, server CA, and Hotspot 2.0 profile template stamped into every subscriber's certificate.
Contact your Helium account owner to get provisioned. Until that's done, the rest of this guide doesn't apply.
2. API key
Once you have a partner record you can be issued an API key. Today this is white-glove: your account owner delivers one out of band. See API keys for roles, rotation, and what to do if one leaks.
Keys are long-lived credentials. Store them in a secrets manager. Never put one in client-side code or version control.
3. Choose an environment
Wi-Fi offload runs two independent environments, production and development, with no sharing between them: separate gateways, partner records, keys, and certificate authorities. Use development for day-to-day integration work and production for real subscribers.
Base URLs, the SDK's environment option, and why a profile installed
against one environment can't authenticate against the other are all
covered in environments.
4. Mobile project setup (SDK only)
If you're going the SDK route:
- iOS: a physical device on iOS 15 or newer, plus Xcode entitlements for Hotspot Configuration and Keychain Sharing. You'll need your Apple Team ID.
- Android:
minSdk 26, and a runtime permission grant forACCESS_FINE_LOCATION.
Full setup steps live in SDK install.