如何运作
两个网络之间的交互
- 01
网络建立联系
双方获取访问密钥以安全通信。
- 02
站点显示在应用中
合作网络获取站点、接口和可用性信息。
- 03
授权驾驶员
驾驶员识别身份后,其网络立即确认是否允许充电。
- 04
完成账单
我们发送电量、时长和金额摘要供网络计费。
可用端点
Base URL: https://api.plugrpay.com.br
| 方法 | 路径 | 说明 | Auth |
|---|---|---|---|
| GET | /ocpi/2.2/versions | 支持的 OCPI 版本 | 公开 |
| GET | /ocpi/2.2/credentials | PlugrPay CPO 凭据和角色 | x-token |
| GET | /ocpi/2.2/locations | 充电站列表(Location 对象) | x-token |
| POST | /ocpi/2.2/tokens/:uid/authorize | 驾驶员令牌授权 | x-token |
| GET | /ocpi/2.2/sessions | 当前和历史充电会话 | x-token |
| GET | /ocpi/2.2/cdrs | 用于计费的 Charge Detail Records | x-token |
示例: GET /ocpi/2.2/locations
GET https://api.plugrpay.com.br/ocpi/2.2/locations?offset=0&limit=10 HTTP/1.1
Host: api.plugrpay.com.br
x-token: your-ocpi-token
Accept: application/json
HTTP/1.1 200 OK
{
"status_code": 1000,
"status_message": "Success",
"timestamp": "2025-05-16T10:00:00Z",
"data": [
{
"id": "charging-station-uuid",
"type": "ON_STREET",
"name": "Shopping Norte EV01",
"address": "Av. Brasil, 1500",
"city": "São Paulo",
"postal_code": "01310-100",
"country": "BRA",
"coordinates": {
"latitude": "-23.561684",
"longitude": "-46.655981"
},
"evses": [
{
"uid": "connector-uuid",
"status": "AVAILABLE",
"connectors": [
{
"id": "1",
"standard": "CCS2",
"format": "SOCKET",
"power_type": "AC_3_PHASE",
"max_voltage": 400,
"max_amperage": 32,
"max_electric_power": 22000
}
]
}
],
"last_updated": "2025-05-16T09:55:00Z"
}
],
"total_count": 142,
"limit": 10,
"offset": 0
}
身份认证
我们使用 OCPI TOKEN_A 方案:在每个请求的x-token 请求头中发送不透明令牌。
合作伙伴 → PlugrPay
合作伙伴使用我们在连接注册时提供的令牌。
GET https://api.plugrpay.com.br/ocpi/2.2/locations HTTP/1.1
x-token: plugrpay-ocpi-token
Host: api.plugrpay.com.br
PlugrPay → 合作伙伴
我们使用凭据交换时由合作伙伴提供的令牌。
GET /versions HTTP/1.1
x-token: <partner-token>
Host: api.partner.example
注意: 除
/versions) 外,所有 OCPI 端点都需要x-token. 缺少令牌或令牌无效时将返回HTTP 401 和 status_code: 2001.测试环境
在不影响生产数据的情况下验证集成。
Base URL
https://api.plugrpay.com.br测试令牌
plugrpay-ocpi-demo-tokenSwagger UIhttps://api.plugrpay.com.br/ocpi/docs
curl 快速测试
# 1. 查看支持的版本(无需认证)
curl https://api.plugrpay.com.br/ocpi/2.2/versions
# 2. 使用测试令牌列出充电站
curl https://api.plugrpay.com.br/ocpi/2.2/locations \
-H "x-token: plugrpay-ocpi-demo-token" \
-H "Accept: application/json"
# 3. 查看 CPO 凭据
curl https://api.plugrpay.com.br/ocpi/2.2/credentials \
-H "x-token: plugrpay-ocpi-demo-token"
