API reference and interactive testing
The API reference on the Ivora developer portal documents every operation of the production contract: scopes, parameters, responses and request samples. These guides explain workflows and architecture. Both describe production; proposed features appear only in guides until implemented and added to OpenAPI.
- Create a scoped
iv_live_key in Developer tools and keep it on your server. - Run
GET /v1/accessfrom your server to confirm current access. Production writes act on real chargers and bills. - Preserve idempotency keys for writes and inspect operations after uncertainty.
The guides embed no authenticated console, collect no credentials and issue no
automatic API requests. Download the live OpenAPI contract.
https://api.ivoracharge.com/docs, the former Swagger UI, redirects to the API
reference.
Endpoint categories
| Reference group | Guide |
|---|---|
| Getting started; Access and API keys | Quickstart, authentication |
| Locations; Stations | Inventory |
| OCPP domains | Custom domains and DNS setup |
| Charger displays | Charger displays, running cost |
| Charging and operations | Commands and transaction state |
| Tariffs and bills; Payments | Managed settlement |
| External charging sessions | Application-managed payments |
| Payment account | Payment account |
| Driver checkout; Legacy checkout | Existing driver settlement |
| Workspaces; Sandbox charging; Sandbox events | Simulation |
| Platform administration | Ivora staff only (display adapters, payment account pins and approval, API key rate limits); tenant applications do not use it |
The production contract has 82 operations in 15 groups: it omits the OCPP domains, Driver checkout and Legacy checkout groups. The Payment account routes are served in production; payments on the account start once Ivora has enabled live payments and approved the account. The live OpenAPI document is authoritative for request fields, required scopes and response schemas. External sessions and settlement reporting are included. Self-service managed-adapter registration remains planned; integrate your own payment processor in your application backend through external sessions.