快速开始 - RiDERgy

本指南带你完成完整流程：从获取凭据到调度充电限制配置文件并使其生效。

前提条件

你需要两样东西，二者都来自 RiDERgy 控制面板：

OAuth 客户端凭据（client_id 和 client_secret）。你的租户必须已启用 Energy Management API。请联系 RiDERgy 启用并创建你的凭据——参见身份验证。
你想要控制的资源的 ID——locationId、充电桩的 controllerUuid/connectorId,或 clusterId。它们来自你的 RiDERgy 账户:如果你拥有已集成位置的 RiDERgy 账户,可以在 RiDERgy 应用中查询这些 ID。它们标识的正是你在应用中看到的相同位置和充电桩。

交互式 “Try it” 面板会向生产环境实时 API 发送请求。此处的 POST/PUT 会更改真实的站点。请仅使用你确实打算应用的值。

1. 检查连通性

GET /health 无需身份验证,用于确认 API 可访问:

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

{ "status": "ok" }

2. 获取访问令牌

使用你的客户端凭据换取 Bearer 令牌（有效期 1 小时）:

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"
  }'

保存响应中的 access_token——你将在后续步骤中使用它。

3. 设置位置的永久限制

永久限制是在没有任何已调度配置文件处于活动状态时应用的回退值。

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. 调度优先级配置文件

在特定时间窗口内以优先级 5 将该位置限制为 50 kW:

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
  }'

配置文件会在其 startTime/endTime 自动应用和撤销——无需进一步调用 API。

5. 验证有效限制

这会返回每个配置文件及其计算得出的 status（SCHEDULED、ACTIVE、EXPIRED），以及当前的 effectiveLimitKw:

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

请参阅优先级模型，了解有效限制的确切解析方式。

后续步骤

身份验证——OAuth 2.0 流程、scopes 和令牌管理。
优先级模型——配置文件、优先级和集群如何相互作用。
使用 API 参考，通过实时环境探索每个端点。

​前提条件

​1. 检查连通性

​2. 获取访问令牌

​3. 设置位置的永久限制

​4. 调度优先级配置文件

​5. 验证有效限制

​后续步骤

前提条件

1. 检查连通性

2. 获取访问令牌

3. 设置位置的永久限制

4. 调度优先级配置文件

5. 验证有效限制

后续步骤