OCPI credentials handshake

The credentials handshake is how two OCPI parties exchange base URLs, tokens, and roles so modules (locations, sessions, CDRs, …) can call each other safely.

Never paste live OCPP passwords, OCPI tokens, or client certificates into tickets, chat, or public issues. Rotate anything that may have been exposed and use Dashboard or your secret store for operational credentials.

What you need

• Your org’s OCPI role (typically CPO, sometimes dual roles)
• Partner (eMSP or hub) versions endpoint and contact
• Agreement on OCPI 2.1.1 and/or 2.2.1

Handshake steps

1. 1

   Discover versions

   Call the peer versions endpoint and pick a mutually supported version before exchanging credentials.

2. 2

   POST credentials

   Exchange tokens and the endpoint inventory for the negotiated version. Exact field shapes differ by version — use the module pages for payloads.

3. 3

   Store partner tokens

   GridOS keeps outbound and inbound tokens for push and pull. Confirm the Dashboard partner record matches the peer role.

4. 4

   Verify the path

   Pull or push a small Locations sample. Confirm the CDRs path if billing is in scope.

Version entry points

Dashboard

Use the Dashboard’s roaming / partner surfaces to:

• Create or import a partner
• Issue or rotate tokens
• Inspect last handshake and module enablement

Common failures

The left sidebar keeps module indexes (not every field table). Open the version overview or use ⌘K search — hit labels include the protocol version (for example · OCPI 2.2.1) so similarly named modules stay distinct.

Related

• Roaming go-live
• OCPI overview
• OCPP — field sessions that feed roaming