Registering users and assets
Connecting assets to markets
Participation starts with registering your users with Axle, and associating them with assets.
To participate in a market, we’ll typically need:
- the user’s addresss, from which we can retrieve the meter identifier
- the user’s tariff, to understand how they pay for energy
- a way to retrieve telemetry from, and send commands to, the asset
Registering users
We’ll setup a hosted flow for you to send via email or in-app notifications.
If you’d like to check a user’s eligibility for flex before surfacing the flow, you can use the eligibility endpoint.
We’ll setup a hosted flow for you to send via email or in-app notifications.
If you’d like to check a user’s eligibility for flex before surfacing the flow, you can use the eligibility endpoint.
Collect user address
Use the Address component to collect the user’s address.
Collect user tariff
Use the Tariff component to collect the user’s tariff.
Adding assets
Once you’ve created a user in our system, we need to associate it with one or more assets.
Retrieve the site ID
When you register a user, we create a site for them. This is a unique identifier for the user, and is used to identify the asset.
Register the asset
Register an asset to that site using the Create Asset endpoint.
Retrieve the site ID
When you register a user, we create a site for them. This is a unique identifier for the user, and is used to identify the asset.
Register the asset
Register an asset to that site using the Create Asset endpoint.
If you have an OAuth flow, we’ll integrate into that to receive delegated access to the asset.
Alternatively, if you have an API with a centralized authorization system, we can submit details of registered assets to an endpoint of your choice.
Managing assets
You can view, update, and delete assets and sites via the API.