Roaming entre redes · OCPI 2.2.1

Motoristas de outras redes nos seus carregadores. E os seus nos deles.

Funciona como o roaming do celular: as redes se conectam por um padrão aberto e o motorista carrega em qualquer uma delas, com o aplicativo ou o cartão que já tem.

Conectar minha rede Documentação técnica

Rede PlugrPayRede parceira

OCPI 2.2.1

RPApp da rede parceira

Green Park SP

Rua Augusta, 500 · 2 livres

Disponível via roaming

Motorista de outra rede

Recarga autorizada

ALLOWED

Como funciona

O que acontece entre as duas redes

01
As redes se apresentam
Cada lado recebe uma chave de acesso para conversar com o outro com segurança.
02
Os pontos aparecem no app
A rede parceira recebe a lista de eletropostos, com endereço, conectores e se estão livres.
03
O motorista é autorizado
Quando ele se identifica no carregador, a rede dele responde na hora se pode carregar.
04
A conta é fechada
No fim, enviamos o resumo da recarga (energia, tempo e valor) para a rede cobrar o motorista.

Endpoints disponíveis

Base URL: https://api.plugrpay.com.br

Método	Caminho	Descrição	Auth
GET	/ocpi/2.2/versions	Versões OCPI suportadas	Público
GET	/ocpi/2.2/credentials	Credenciais e roles do CPO PlugrPay	🔑 x-token
GET	/ocpi/2.2/locations	Lista de eletropostos (Location objects)	🔑 x-token
POST	/ocpi/2.2/tokens/:uid/authorize	Autorização de token de motorista	🔑 x-token
GET	/ocpi/2.2/sessions	Sessões de recarga ativas e históricas	🔑 x-token
GET	/ocpi/2.2/cdrs	Charge Detail Records para faturamento	🔑 x-token

Exemplo: 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": "uuid-do-eletroposto",
      "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": "uuid-do-conector",
          "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
}

Autenticação

Usamos o esquema TOKEN_A do OCPI: um token opaco enviado no headerx-token em cada requisição.

Parceiro → PlugrPay

O parceiro usa o token que fornecemos durante o cadastro da conexão.

GET https://api.plugrpay.com.br/ocpi/2.2/locations HTTP/1.1
x-token: plugrpay-ocpi-token
Host: api.plugrpay.com.br

PlugrPay → Parceiro

Quando chamamos o parceiro, usamos o token que o parceiro nos forneceu durante o handshake de credenciais.

GET /versions HTTP/1.1
x-token: <token-do-parceiro>
Host: api.parceiro.com.br

Atenção: Todos os endpoints OCPI (exceto /versions) exigem o header x-token. Requisições sem token ou com token inválido recebem HTTP 401 com status_code: 2001.

Ambiente de teste

Use o ambiente de sandbox para validar sua integração sem afetar dados de produção.

Base URLhttps://api.plugrpay.com.br

Token de testeplugrpay-ocpi-demo-token

Swagger UIhttps://api.plugrpay.com.br/ocpi/docs

Teste rápido com curl

# 1. Verificar versões suportadas (sem autenticação)
curl https://api.plugrpay.com.br/ocpi/2.2/versions

# 2. Listar eletropostos com token de teste
curl https://api.plugrpay.com.br/ocpi/2.2/locations \
  -H "x-token: plugrpay-ocpi-demo-token" \
  -H "Accept: application/json"

# 3. Verificar credenciais do CPO
curl https://api.plugrpay.com.br/ocpi/2.2/credentials \
  -H "x-token: plugrpay-ocpi-demo-token"

Vamos conectar as nossas redes?

Escreva para integradores@plugrpay.com.br e liberamos o ambiente de teste.

Enviar e-mail Abrir a documentação