> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ridergy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vérification de l'état

> Vérification de l'état du service, sans authentification. Ne nécessite pas de clé API.



## OpenAPI

````yaml /api-reference/energy-management/openapi.fr.yaml GET /health
openapi: 3.1.0
info:
  title: RiDERgy Energy Management API
  version: '1.0'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  description: >
    Contrôle programmatique des limites de puissance de charge sur les sites,

    les bornes individuelles, les organisations et les clusters multi-sites.


    ## Authentification

    Tous les endpoints sauf `GET /health` nécessitent un en-tête `x-api-key`.
    Cette

    clé détermine votre tenant — elle n'est jamais lue depuis le corps de la

    requête ni depuis un autre en-tête, ainsi une clé d'un tenant ne peut pas

    accéder aux données d'un autre tenant.


    Votre tenant doit avoir la fonctionnalité Energy Management API activée,

    sinon les requêtes échouent avec `403 FEATURE_NOT_ENABLED`. Contactez
    RiDERgy

    pour l'activer.


    ## Modèle de priorité

    Les limites de site et de borne sont contrôlées via des **profils à fenêtres

    de priorité** :


    - Les priorités vont de **0 (la plus basse) à 10 (la plus haute)**, dans le
      style de la pile OCPP.
    - Une cible (site ou connecteur de borne) peut avoir jusqu'à 11 profils, un
      par niveau de priorité, chacun avec sa propre fenêtre `[startTime, endTime)`.
    - À tout moment, la **limite effective** est le `limitKw` du profil de
      priorité la plus élevée dont la fenêtre est actuellement active.
    - Si aucun profil n'est actif, un site revient à son `permanentLimitKw`.

    - Soumettre un profil à une priorité qui en possède déjà un pour cette cible
      le **remplace**.
    - Les profils sont appliqués et annulés automatiquement à leurs
      `startTime`/`endTime` — aucun appel d'API supplémentaire n'est nécessaire
      une fois le profil créé. Les enregistrements de profils ne sont jamais
      supprimés, l'historique reste donc consultable.

    ## Erreurs

    Toutes les erreurs partagent cette forme :


    ```json

    {
      "error": {
        "code": "LOCATION_NOT_FOUND",
        "message": "Location 123 was not found for the provided tenant",
        "requestId": "b1f6e6b0-..."
      }
    }

    ```
servers:
  - url: https://api.ridergy.com/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Vérification de l'état du service, sans authentification.
  - name: Locations
    description: >-
      Lire et définir les limites de puissance et les profils de priorité au
      niveau du site.
  - name: Chargers
    description: >-
      Verrouiller des connecteurs de borne individuels sur une limite de
      puissance fixe pour une fenêtre temporelle.
  - name: Organizations
    description: >-
      Profils de plafond à l'échelle du tenant (enregistrés uniquement —
      l'application n'est pas encore active).
  - name: Clusters
    description: >-
      Regrouper des sites sous un plafond kW partagé et appliquer des plannings
      à l'ensemble du groupe.
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: >-
        Vérification de l'état du service, sans authentification. Ne nécessite
        pas de clé API.
      operationId: getHealth
      responses:
        '200':
          description: Le service est opérationnel
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clé API par tenant. Le tenant est déterminé à partir de la clé — jamais
        à partir de la requête.

````