What is the veXAPI and how do I access it?

What is the veXAPI and how do I access it?

Our Customers are asking, via our Feature Requests link on the Village Energy website, for integration with Home Assistant.

In response, we are pleased to announce the trial of an external API (called ‘veXAPI’) that allows Customers to access asset, telemetry and automations associated with their Voltello account as the first step towards enabling this integration. The purpose of the trial is to assess the value for Customers of having API access to these services and to explore what additional features and capabilities might be useful for them in order to increase the role of automation within their home.

Access to the veXAPI is provided via an API key that can be created from the ‘Manage Access’ menu option and then pressing the ‘API Access’ button. API keys that have been created for the Customer can be copied to the device using the 'copy'  icon.

The draft API Documentation can be accessed here

Support for the veXAPI is limited, although our engineers will be monitoring the public discussion for feedback and comments.
We look forward to adding new capabilities based on your feedback.
    • Related Articles

    • veXAPI: Terms of Use & Important Information

      Customers can generate, delete, suspend and copy API keys from the ‘Menu / Manage Access / API Access’ menu in the Voltello App. Sharing API keys to your account is the same as sharing your username and password. If you suspect an API key has been ...
    • How can I retrieve my Amber API key?

      Go to www.amber.com.au and log in to your account. 2. Click on "For Developers" on the left hand menu of options. Then select "Generate a new token". 3. Label the API key something unique like "Battery Testing" or similar and then click 'Generate'. ...
    • How do I delegate access to my account?

      You can share (delegate) access to your Voltello Account with others, and remove access at any time. When you share access to your account, the delegated user will be able to: Accept and modify plans View your energy data Control your devices Add and ...
    • Can I delegate access to my home energy management system?

      Yes, you can delegate access to family members or other trusted individuals. This allows them to help with configuration and management of your account and plans, providing flexibility and convenience. By delegating access to your account to another ...
    • How do I give my installer access to my Voltello account?

      After creating your account in the Voltello app, you will need to share access with your installer. This can be done through the app by following the step-by-step guide provided. The installer will then be able to complete the provisioning process. ...