BRP API

Introduction

Beware that this API is still in Beta, and can be subject to large changes. Emulate's BRP API allows BRPs to access and manage their virtual batteries. Such access is granted via a cryptographically signed JSON Web Token used in the Authorization header of the BRP API requests.

Make a Request To The Emulate BRP API

Before querying the Emulate BRP API, generate a JSON Web Token. For details on JWT generation, see Authorization.

The Emulate API supports the following environments:

Productionhttps://api.emulate.network/

Staging https://api.stage.emulate.network/

To make a request to the Retailer API, set up the HTTP Authorization header using the Bearer mechanism.

Troubleshooting

If you get a 403 (access denied) error in the response to your Retailer API request, check the following:

✓The JWT is syntactically valid. Validate your token by pasting it in the JWT tool.

✓The signing algorithm is RS256.

✓The key corresponds to the environment you are using.

✓The key is generated for the Single Customer API, not the Retailer API.

✓The correct retailer ID is used.

✓The token has not expired.

REST API

The main BRP API is a REST API with an OpenAPI specification, which lives under /v1/brp. The detailed specification can be found here: BRP API Reference.

BRP Reporting GraphQL

There is a GraphQL route for fetching data about virtual batteries and their devices available under the route v1/brp/reporting.The full schema for this can be found here: BRP Reporting GraphQL.

What to read next

→

For a full description of the REST api requests, responses, and parameters, see the BRP API Reference. To download the complete API Reference, navigate to the BRP API Reference page and click Download OpenAPI spec.

For a full schema of the reporting GraphQL route, see BRP Reporting GraphQL.