Getting started

Review the core concepts of the Energy Coordination API to understand how it works. If you already understand the basics, follow this guide to get started with the API.

Tip

• We have a Postman Collection with all the endpoints from the API and a quickstart guide, download the collection here and import it into Postman.
• You can use this GitHub repository which contains reference code implementations for interacting with the Energy Coordination Api.

Environments

Sandbox Swagger-page for the Sandbox environment

Production Swagger-page for the Production environment

Important

When you start integrating with the API, you should use the Sandbox environment to test your implementation. When you are ready to move to production you must go through a manual approval process.

How to get started

As a DER-partner, you must go through the following steps to get started with the Energy Coordination API:

1. Register at Spark Studio

   Go to Spark Studio and sign up to receive credentials.

2. Get ready to interact with the API

   Here are some tools to help you get going with the API

   • Swagger UI: https://api.sandbox.voluespark.com/energy-coordination/v1/
   • Postman collection: We have a Postman Collection with all the endpoints from the API and a quickstart guide, download the collection here and import it into Postman.
   • Reference implementation: You can use this GitHub repository which contains reference code implementations for interacting with the Energy Coordination Api.

   Also see our section about authentication

   How to authenticate Learn how to authenticate with Energy Coordination API

3. Add your resources

   We have a designated area in the Sandbox environment for testing purposes. You can add your resources there and they will be marked as eligible immediately.

   Adding Resources Learn how to add resources to the test area

4. Integrate with programs

   There are two programs you can integrate with. Users will generate compensation by reacting to events specified by the programs. In addition, every enrolled user will receive a monthly compensation for participating in Spark.

   • Price Incentives
   • Limitation of Power Consumption Beta

   For more information regarding compensation, see compensation breakdown.

5. Fetch user compensations

   After you have reported on energy usage, you can fetch the compensations for the users that are affected by the event.

   User Compensations Learn how to fetch user compensations

6. Go to production

   When you’ve gone through these steps and verified that everything works as expected, you are ready to move to the production environment.

   Going to Production Learn how to move your resources to the production environment