API B2B
A API B2B é o contrato REST para parceiros integrarem recarga na VoltBras. O prefixo de todas as rotas é /b2b.
| Ambiente | Base URL |
|---|---|
| Staging | https://b2b.staging.voltbras.com.br |
| Production | https://b2b.voltbras.com.br |
Esta documentação descreve os fluxos em português. A referência de cada operação (campos, tipos e exemplos) é gerada do OpenAPI e permanece em inglês, no mesmo texto dos controllers.
Ordem típica
- Cadastre o consumidor externo em
POST /b2b/consumer. Consulte um consumidor já existente, pelo id numérico, emGET /b2b/consumer/{id}. - Inicie a recarga em
POST /session/start. - Acompanhe em
GET /sessionouGET /session/{id}. - Encerre em
POST /session/stop.
O cadastro dos pontos de recarga usa GET /charge-point. O status e o preço de um ponto, na hora de escolher onde carregar, estão em GET /charge-point/{id}.
POST //charge-point/command envia comandos para o simulador de estação. Não faz parte do fluxo de recarga de um consumidor real.
Para receber avisos de sessão e de pedido, configure POST /webhook.