Skip to main content
This guide takes you end to end — from getting your credentials to scheduling a charging-limit profile and watching it take effect.

Prerequisites

You need two things, both from the RiDERgy dashboard:
  1. OAuth client credentials (client_id and client_secret). Your tenant must have the Energy Management API enabled. Contact RiDERgy to enable it and create your credentials — see Authentication.
  2. The IDs of the resources you want to control — a locationId, a charger’s controllerUuid/connectorId, or a clusterId. These come from your RiDERgy account: if you have a RiDERgy account with an integrated location, you can look the IDs up in the RiDERgy app. They identify the same locations and chargers you see there.
The interactive Try it panels send requests to the live production API. A POST/PUT here changes a real site. Only use values you actually intend to apply.

1. Check connectivity

GET /health needs no authentication and confirms the API is reachable:

2. Obtain an access token

Exchange your client credentials for a Bearer token (valid for 1 hour):
Save the access_token from the response — you’ll use it in the following steps.

3. Set a location’s permanent limit

The permanent limit is the fallback applied whenever no scheduled profile is active.

4. Schedule a priority profile

Limit the location to 50 kW during a specific window, at priority 5:
The profile is applied and reverted automatically at its startTime/endTime — no further API calls are needed.

5. Verify the effective limit

This returns every profile with a computed status (SCHEDULED, ACTIVE, EXPIRED) and the current effectiveLimitKw:
See the Priority model for exactly how the effective limit is resolved.

Next steps

  • Authentication — OAuth 2.0 flow, scopes, and token management.
  • Priority model — how profiles, priorities, and clusters interact.
  • Use the API Reference to explore every endpoint with a live playground.