Démarrage rapide

Ce guide vous accompagne de bout en bout : de l’obtention de vos identifiants à la planification d’un profil de limite de charge et à son application.

Prérequis

Vous avez besoin de deux choses, toutes deux issues du tableau de bord RiDERgy :

Des identifiants client OAuth (client_id et client_secret). L’API Energy Management doit être activée pour votre locataire. Contactez RiDERgy pour l’activer et créer vos identifiants — voir Authentification.
Les identifiants des ressources que vous souhaitez contrôler : un locationId, le controllerUuid/connectorId d’une borne, ou un clusterId. Ils proviennent de votre compte RiDERgy : si vous avez un compte RiDERgy avec un site intégré, vous pouvez consulter ces identifiants dans l’application RiDERgy. Ils désignent les mêmes sites et bornes que ceux que vous y voyez.

Les panneaux interactifs « Try it » envoient des requêtes à l’API de production en direct. Un POST/PUT modifie ici un site réel. N’utilisez que des valeurs que vous comptez réellement appliquer.

1. Vérifier la connectivité

GET /health ne nécessite aucune authentification et confirme que l’API est accessible :

curl https://api.ridergy.com/v1/health

{ "status": "ok" }

2. Obtenir un jeton d’accès

Échangez vos identifiants client contre un jeton Bearer (valide 1 heure) :

curl -X POST https://api.ridergy.com/v1/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  }'

Enregistrez le access_token de la réponse — vous l’utiliserez dans les étapes suivantes.

3. Définir la limite permanente d’un site

La limite permanente est la valeur de repli appliquée lorsqu’aucun profil planifié n’est actif.

curl -X PUT https://api.ridergy.com/v1/locations/{locationId}/limit \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "limitKw": 100 }'

4. Planifier un profil de priorité

Limitez le site à 50 kW pendant une fenêtre donnée, à la priorité 5 :

curl -X POST https://api.ridergy.com/v1/locations/{locationId}/schedules \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "startTime": "2026-01-01T08:00:00Z",
    "endTime":   "2026-01-01T18:00:00Z",
    "limitKw":   50,
    "priority":  5
  }'

Le profil est appliqué et annulé automatiquement à ses startTime/endTime — aucun appel d’API supplémentaire n’est nécessaire.

5. Vérifier la limite effective

Ceci renvoie chaque profil avec un status calculé (SCHEDULED, ACTIVE, EXPIRED) et la effectiveLimitKw actuelle :

curl https://api.ridergy.com/v1/locations/{locationId}/limits \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Consultez le Modèle de priorité pour savoir exactement comment la limite effective est déterminée.

Étapes suivantes

Authentification — flux OAuth 2.0, scopes et gestion des jetons.
Modèle de priorité — comment les profils, priorités et clusters interagissent.
Utilisez la Référence de l’API pour explorer chaque endpoint avec un environnement en direct.

Premiers pas

Concepts

Démarrage rapide

Prérequis

1. Vérifier la connectivité

2. Obtenir un jeton d’accès

3. Définir la limite permanente d’un site

4. Planifier un profil de priorité

5. Vérifier la limite effective

Étapes suivantes

​Prérequis

​1. Vérifier la connectivité

​2. Obtenir un jeton d’accès

​3. Définir la limite permanente d’un site

​4. Planifier un profil de priorité

​5. Vérifier la limite effective

​Étapes suivantes

Prérequis

1. Vérifier la connectivité

2. Obtenir un jeton d’accès

3. Définir la limite permanente d’un site

4. Planifier un profil de priorité

5. Vérifier la limite effective

Étapes suivantes