APIs & Integration
One central explanation. Exact runtime details locally.
Neleso.com explains API purpose, stability and product scope. In the target model, each installation exposes the OpenAPI specification for its own release and a local Swagger UI. Community and Enterprise already expose both locally; the Standalone Broker will follow. Enterprise now manages API keys in CPMS; only account, audit and admin functions that have not yet migrated remain temporarily in a local operations surface.
Single Source
Product code generates the contract.
In the target model, the same versioned OpenAPI specification feeds the central reference and the local Swagger UI. Customer domains, demo credentials and production-specific servers do not belong in the public contract.
API catalogue
Different surfaces, clearly named contracts.
Status here means a published and supported OpenAPI contract, not internal routes. “Contract planned” is therefore not a public interface that has already shipped.
| API | Broker | Community | Enterprise |
|---|---|---|---|
| Broker Control APIConnections · targets · routing | Contract planned | Contract planned | Available |
| OCPP Server APIStations · state · commands | Contract planned | Contract planned | Available |
| CPMS Core APISessions · tokens · configuration | Available | Available | |
| Headless CPMS APIExternal integration surface | Available | ||
| Fleet & Driver APIsFleet · drivers · energy | Available |
Runtime Swagger
Local developer tooling deliberately remains.
The exact mount may vary by installation. Product navigation should link directly to local Swagger; no separate login or second documentation navigation is required.
/api/docs/swagger-uiBroker, OCPP Server and CPMS Core – on the respective service or installation proxy.
Open live Community Swagger →Open Enterprise CPMS Swagger →/api/docs/openapi.jsonRaw machine-readable specification for generators, tests and custom clients.
/docsHeadless CPMS currently uses this shorter Swagger path.
Open Enterprise Headless Swagger →Some Enterprise surfaces still load assets from a public CDN today. Bundling those assets locally is part of the product roadmap.
Target governance
New public contracts should meet these rules.
This is the target governance, not a retrospective guarantee for every current internal or unversioned route.
Versioning
New public paths and schemas are assigned to a named API version.
Authentication
External APIs receive revocable keys or bearer tokens with scopes appropriate to the product.
Tenant boundaries
Where multi-tenancy applies, context is derived server-side from identity.
Deprecation
Public contracts removed in future should be named, tested and accompanied by a traceable migration path.