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. Add your resources to the test area

   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

3. Create webhook subscriptions

   You should set up a webhook to receive event notifications from the API. This allows your system to be notified when an event occurs.

   Webhook Subscriptions Learn how to set up a webhook to receive events

4. Simulate events

   You must simulate events in the test area to see how your resources react to different situations. These can be fetched in the API.

   Simulate Events Learn how to simulate events in the test area

5. Report on energy usage

   After you react to an event, you must report the resource usage back to the API. This is done by sending a report.

   Reporting Energy Usage Learn how to send reports on energy usage

6. 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

7. 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