Authentication
Authentication can be done in two different ways. Session tokens are useful for frontend calls, while API keys are useful for backend calls.- API Key:
Add your API key in the header
x-ws-api-key
->{ 'x-ws-api-key': '{apiKey}' }
- Session Token:
Add the token in the header
Authorization
as:Bearer {sessionToken}
->{ 'Authorization': 'Bearer {sessionToken}' }
How to Get a Session Token
Use this endpoint to get a session token (helpful for frontend calls):[POST] /v1/onboarding/session-token/generate
Steps to Onboard a Home
1. Fetch Utilities and Rate Plans
Fetch all utilities and rate plans for a given zip code.[POST] /v1/utility/get
2. Create a Home
Create Home with basic details, connecting to the utility, and select a rate plan.[POST] /v1/homes/create
3. Create Solar (if needed)
Provide details about Solar System.[POST] /v1/homes/solar/create