Documentation
Guides and reference for ocpi-kit — the ideas behind the crate, a walkthrough of every layer, and the interop knowledge you need to talk to real OCPI peers.
ocpi-kit implements OCPI — the Open Charge Point Interface, the
protocol that carries EV roaming traffic between Charge Point Operators, e-Mobility Service
Providers and roaming hubs.
This guide explains the ideas the crate is built on and how each layer is meant to be used. For item-by-item API detail, see docs.rs/ocpi-kit.
New to the protocol? OCPI in brief covers the roles, modules and the Sender/Receiver distinction the rest of this guide assumes.
Where to start
- You want to talk to a peer → Your first request
- You want to expose an OCPI API → Server
- You are building a hub → Hub
- You want to check an invoice → Tariffs
- You are consuming CDRs → Reading a CDR
- Your partner needs something to integrate against → Testkit
- A partner's implementation is misbehaving → Conformance
- You just want a command line tool → The CLI
- You want to know whether to trust any of this → How it is verified
- You want to know why it is shaped like this → Design decisions
Getting started
Install ocpi-kit, pick your features, and make the first request.
Concepts
The ideas the crate is built on: how it parses, how it validates, how it handles money, enums, extensions and versions — and what a CDR consumer has to get right.
Layers
Transport, client, server, hub, tariffs, the conformance runner and the testkit — what each one does for you.
Reference
Verification, interop quirks, specification errata, the design decisions behind the crate, security, and the repository automation.