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

# Início rápido

> Faça a sua primeira solicitação à API Energy Management em minutos

Este guia leva-o do início ao fim: desde obter as suas credenciais até agendar um perfil de limite de carregamento e vê-lo entrar em vigor.

## Pré-requisitos

Precisa de duas coisas, ambas a partir do **painel da RiDERgy**:

1. **Credenciais de cliente OAuth** (`client_id` e `client_secret`). O seu tenant tem de ter a API Energy Management ativada. Contacte a RiDERgy para a ativar e criar as suas credenciais — consulte [Autenticação](/pt/authentication).
2. **Os IDs dos recursos que pretende controlar**: um `locationId`, o `controllerUuid`/`connectorId` de um carregador, ou um `clusterId`. Provêm da sua conta RiDERgy: se tiver uma conta RiDERgy com uma localização integrada, pode consultar os IDs na **app RiDERgy**. Identificam as mesmas localizações e carregadores que vê aí.

<Note>
  Os painéis interativos **«Try it»** enviam solicitações para a **API de produção em tempo real**. Um `POST`/`PUT` aqui altera uma localização real. Use apenas valores que pretenda realmente aplicar.
</Note>

## 1. Verificar a conectividade

`GET /health` não requer autenticação e confirma que a API está acessível:

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

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

## 2. Obter um token de acesso

Troque as suas credenciais de cliente por um token Bearer (válido por 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"
  }'
```

Guarde o `access_token` da resposta — vai utilizá-lo nos passos seguintes.

## 3. Definir o limite permanente de uma localização

O limite permanente é o valor de reserva aplicado sempre que nenhum perfil agendado está ativo.

```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. Agendar um perfil de prioridade

Limite a localização a 50 kW durante uma janela específica, com prioridade 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
  }'
```

O perfil é aplicado e revertido automaticamente nos seus `startTime`/`endTime` — não são necessárias mais chamadas à API.

## 5. Verificar o limite efetivo

Isto devolve cada perfil com um `status` calculado (`SCHEDULED`, `ACTIVE`, `EXPIRED`) e o `effectiveLimitKw` atual:

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

Consulte o [Modelo de prioridades](/pt/concepts/priority-model) para saber exatamente como o limite efetivo é determinado.

## Próximos passos

* [Autenticação](/pt/authentication) — fluxo OAuth 2.0, scopes e gestão de tokens.
* [Modelo de prioridades](/pt/concepts/priority-model) — como perfis, prioridades e clusters interagem.
* Use a **Referência da API** para explorar cada endpoint com um ambiente ao vivo.


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