An API key is a unique identifier used to authenticate requests to a web service. In the context of Fox ESS Cloud, it allows third-party applications - like Capture AI - to securely access your inverter data.
An API key can be used to:
Log in to your FoxESSCloud account, click on the user icon at the top right corner of the screen and click User Profile.
Select API Management from the menu on the left. Under the Private Token section, click the Generate API key button.
If you had previously generated an API key, this will invalidate the old one and create a new key - you might see a prompt asking you to confirm this. If you were using the old key for other third party services, make sure to update them with the new key once it’s generated.
⚠️ Important: Just like with passwords, keep your API token secure. If shared, it can be used to access your inverter data.
Copy the API key and share it with the Capture Energy Team by pasting it securely into the online form. For security purposes, you will not be able to see the API key in its entirety again, and will need to generate a new one if you fail to copy it immediately after it’s been created.