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

# Inicio rápido

> Haz tu primera solicitud a la API de Energy Management en minutos

Esta guía te lleva de principio a fin: desde obtener tus credenciales hasta programar un perfil de límite de carga y ver cómo surte efecto.

## Requisitos previos

Necesitas dos cosas, ambas desde el **panel de RiDERgy**:

1. **Credenciales de cliente OAuth** (`client_id` y `client_secret`). Tu tenant debe tener habilitada la API de Energy Management. Contacta con RiDERgy para habilitarla y crear tus credenciales — consulta [Autenticación](/es/authentication).
2. **Los IDs de los recursos que quieres controlar**: un `locationId`, el `controllerUuid`/`connectorId` de un cargador, o un `clusterId`. Provienen de tu cuenta de RiDERgy: si tienes una cuenta de RiDERgy con una ubicación integrada, puedes consultar los IDs en la **app de RiDERgy**. Identifican las mismas ubicaciones y cargadores que ves allí.

<Note>
  Los paneles interactivos de **«Try it»** envían solicitudes a la **API de producción en vivo**. Un `POST`/`PUT` aquí modifica una ubicación real. Usa solo valores que realmente quieras aplicar.
</Note>

## 1. Comprobar la conectividad

`GET /health` no requiere autenticación y confirma que la API es accesible:

```bash theme={null}
curl https://api.ridergy.com/v1/health
```

```json theme={null}
{ "status": "ok" }
```

## 2. Obtener un token de acceso

Intercambia tus credenciales de cliente por un token Bearer (válido durante 1 hora):

```bash theme={null}
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"
  }'
```

Guarda el `access_token` de la respuesta — lo usarás en los siguientes pasos.

## 3. Establecer el límite permanente de una ubicación

El límite permanente es el valor de reserva que se aplica cuando no hay ningún perfil programado activo.

```bash theme={null}
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. Programar un perfil de prioridad

Limita la ubicación a 50 kW durante una ventana específica, con prioridad 5:

```bash theme={null}
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
  }'
```

El perfil se aplica y se revierte automáticamente en su `startTime`/`endTime` — no se necesitan más llamadas a la API.

## 5. Verificar el límite efectivo

Esto devuelve cada perfil con un `status` calculado (`SCHEDULED`, `ACTIVE`, `EXPIRED`) y el `effectiveLimitKw` actual:

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

Consulta el [Modelo de prioridad](/es/concepts/priority-model) para ver exactamente cómo se resuelve el límite efectivo.

## Próximos pasos

* [Autenticación](/es/authentication) — flujo OAuth 2.0, scopes y gestión de tokens.
* [Modelo de prioridad](/es/concepts/priority-model) — cómo interactúan perfiles, prioridades y clústeres.
* Usa la **Referencia de la API** para explorar cada endpoint con un entorno en vivo.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.