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

# Comprobación de estado

> Comprobación de estado sin autenticación. No requiere una clave de API.



## OpenAPI

````yaml /api-reference/energy-management/openapi.es.yaml GET /health
openapi: 3.1.0
info:
  title: RiDERgy Energy Management API
  version: '1.0'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  description: |
    Control programático de los límites de potencia de carga en ubicaciones,
    cargadores individuales, organizaciones y clústeres entre ubicaciones.

    ## Autenticación
    Todos los endpoints excepto `GET /health` requieren una cabecera
    `x-api-key`. La clave determina tu tenant — nunca se lee del cuerpo de la
    solicitud ni de ninguna otra cabecera, por lo que una clave de un tenant no
    puede acceder a los datos de otro tenant.

    Tu tenant debe tener habilitada la función Energy Management API; de lo
    contrario, las solicitudes fallarán con `403 FEATURE_NOT_ENABLED`. Contacta
    con RiDERgy para habilitarla.

    ## Modelo de prioridad
    Los límites de ubicación y de cargador se controlan mediante **perfiles con
    ventanas de prioridad**:

    - Las prioridades van de **0 (la más baja) a 10 (la más alta)**, al estilo
      de la pila OCPP.
    - Un objetivo (ubicación o conector de cargador) puede tener hasta 11
      perfiles, uno por nivel de prioridad, cada uno con su propia ventana
      `[startTime, endTime)`.
    - En cualquier momento, el **límite efectivo** es el `limitKw` del perfil
      de mayor prioridad cuya ventana esté actualmente activa.
    - Si no hay ningún perfil activo, una ubicación recurre a su
      `permanentLimitKw`.
    - Enviar un perfil con una prioridad que ya tiene uno para ese objetivo lo
      **reemplaza**.
    - Los perfiles se aplican y revierten automáticamente en su
      `startTime`/`endTime` — no se necesitan más llamadas a la API una vez
      creado un perfil. Los registros de perfiles nunca se eliminan, por lo que
      el historial sigue siendo consultable.

    ## Errores
    Todos los errores comparten esta forma:

    ```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: Comprobación de estado del servicio sin autenticación.
  - name: Locations
    description: >-
      Consultar y establecer límites de potencia y perfiles de prioridad a nivel
      de ubicación.
  - name: Chargers
    description: >-
      Bloquear conectores de cargadores individuales a un límite de potencia
      fijo durante una ventana de tiempo.
  - name: Organizations
    description: >-
      Perfiles de límite a nivel de organización (solo se registran; la
      aplicación aún no está activa).
  - name: Clusters
    description: >-
      Agrupar ubicaciones bajo un límite de kW compartido y aplicar horarios
      entre ellas.
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Comprobación de estado sin autenticación. No requiere una clave de API.
      operationId: getHealth
      responses:
        '200':
          description: El servicio está funcionando correctamente
          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: >-
        Clave de API por tenant. El tenant se deriva de la clave — nunca de la
        solicitud.

````