How to Get Your Fox ESS API Key
Your Fox ESS API key is required to connect third-party applications like Check My Solar to your Fox ESS solar system. This guide shows you how to generate and retrieve your API key from the Fox ESS Cloud platform.
What is a Fox ESS API Key?
Section titled “What is a Fox ESS API Key?”The Fox ESS API (Application Programming Interface) key is a unique authentication credential that allows authorized applications to securely access your solar system data from the Fox ESS Cloud platform. This key enables real-time monitoring of your inverter, battery status, energy production, and consumption data through third-party apps like Check My Solar.
Step-by-Step Instructions
Section titled “Step-by-Step Instructions”Step 1: Login to Fox ESS Cloud
Section titled “Step 1: Login to Fox ESS Cloud”Visit foxesscloud.com and log in with your Fox ESS Cloud account credentials. If you don’t have an account yet, you’ll need to create one and ensure your solar system is registered.
Step 2: Navigate to User Profile
Section titled “Step 2: Navigate to User Profile”Once logged in, click on your username or profile icon in the top right corner of the dashboard. From the dropdown menu, select User Profile or Account Settings to access your account management area.
Step 3: Access API Management
Section titled “Step 3: Access API Management”In your User Profile section, look for API Management in the sidebar or navigation menu. Open it to access the API key management interface.
Step 4: Generate API Key
Section titled “Step 4: Generate API Key”In the API Management section, find the button labeled Generate API Key or Create New API Key. Click it to create your unique API key. The system will generate a new key for you.
Step 5: Copy and Save Your API Key
Section titled “Step 5: Copy and Save Your API Key”Once generated, your API key will be displayed on the screen. Important: copy this key immediately and store it in a secure location. For security reasons, you may not be able to view the complete key again after leaving this page.
Important Notes
Section titled “Important Notes”- Keep your API key confidential: treat your API key like a password. Never share it publicly or commit it to public repositories.
- API rate limits: be aware that Fox ESS Cloud has rate limits on API requests. Avoid making excessive API calls to prevent temporary access restrictions.
Using Your API Key with Check My Solar
Section titled “Using Your API Key with Check My Solar”If you’re already signed in
Section titled “If you’re already signed in”If you’re already using Check My Solar and want to link an additional Fox Cloud account, or switch to API key authentication:
- Open the app, open the sidebar menu, then open Account Settings.
- Select the Fox Cloud Accounts tab.
- Tap Link Another Account.
- In the Link Your Fox Cloud Account screen that appears, select the API Key tab.
- Optionally, enter an Account Name (e.g. “My Fox Cloud Account”). If left blank, it defaults to “API Key Account”.
- Paste your Fox Cloud API key into the Fox Cloud API Key field.
- Tap Link API Key to connect.
If you’re signing in for the first time
Section titled “If you’re signing in for the first time”After signing in to Check My Solar, you’ll be taken directly to the Link Your Fox Cloud Account screen:
- Select the API Key tab (the default is Quick Connect - see tip below).
- Optionally, enter an Account Name.
- Paste your Fox Cloud API key into the Fox Cloud API Key field.
- Tap Link API Key to connect.
Your API key is encrypted and stored securely. After a successful link, you’ll be redirected to your dashboard automatically.
After connecting, Check My Solar will begin syncing your solar system data, giving you access to real-time monitoring, energy forecasts, battery status, and analytics.
Lost Your API Key?
Section titled “Lost Your API Key?”If you’ve lost your API key, you can generate a new one following the same steps above. Note that generating a new key will invalidate the previous one, so you’ll need to update all applications using the old key.