APIs & Integration
Zentrale API-Dokumentation und lokale Swagger-Oberflächen
NeLeSo Developer dokumentiert Zweck, Stabilität und Produktumfang der APIs. Installierte Gateway- und Platform-Releases können für freigegebene Dienste versionsgenaue OpenAPI-Spezifikationen lokal bereitstellen. Das Developer Kit ist noch nicht veröffentlicht; sein Inhalt und seine Lizenz bleiben bis zum Rechte- und Security-Review offen.
Single Source
Versionierte Spezifikationen für Dokumentation und Runtime.
Für jeden veröffentlichten Dienstvertrag verbindet eine versionierte OpenAPI-Spezifikation die zentrale Referenz mit der lokalen Swagger-Oberfläche. Kundendomains, Demo-Zugänge und produktionsspezifische Server sind kein Bestandteil des öffentlichen Vertrags.
API-Katalog
Unterschiedliche Oberflächen, klar benannte Verträge.
Die Matrix zeigt veröffentlichte und unterstützte OpenAPI-Verträge. Interne oder unversionierte Routen sind nicht als öffentliche Schnittstellen ausgewiesen.
| API | OCPP Gateway | Charging Platform | Developer Kit |
|---|---|---|---|
| Gateway Control APIVerbindungen · Ziele · Routing | Nicht öffentlich | Produktintern | Nicht veröffentlicht |
| OCPP Server APIStationen · Status · Kommandos | Nicht öffentlich | Je Release | Nicht veröffentlicht |
| CPMS Core APISessions · Tokens · Konfiguration | Je Release | ||
| Headless CPMS APIExterne Integrationsfläche | Je Release | ||
| Fleet & Driver APIsFlotte · Fahrer · Energie | Je Release |
Runtime Swagger
Lokale Entwicklerwerkzeuge bleiben bewusst erhalten.
Der Pfad kann je Installation abweichen. Lokale Swagger-Ansichten gehören zum installierten, freigegebenen Release; Produkt-, Architektur- und Integrationsdokumentation bleibt zentral bei NeLeSo Developer.
/api/docs/swagger-uiGateway-Dienste, OCPP Server und CPMS Core – jeweils am betreffenden Dienst oder über den Installationsproxy.
Sandbox-CPMS-Swagger öffnen →/api/docs/openapi.jsonRohe, maschinenlesbare Spezifikation für Generatoren, Tests und eigene Clients.
/docsHeadless CPMS verwendet heute diesen kürzeren Swagger-Pfad.
Sandbox-Headless-Swagger öffnen →Lokale Swagger-Oberflächen dokumentieren den Runtime-Vertrag. NeLeSo Developer bleibt die zentrale Quelle für Architektur, Produkte und Integration.
API-Regeln
Öffentliche API-Verträge folgen vier Regeln.
Diese Regeln gelten für veröffentlichte, versionierte APIs. Interne und unversionierte Routen sind keine öffentlichen Verträge.
Versionierung
Neue öffentliche Pfade und Schemas werden einer benannten API-Version zugeordnet.
Authentifizierung
Externe APIs erhalten widerrufbare Schlüssel oder Bearer-Tokens mit den zum Produkt passenden Scopes.
Mandantengrenzen
Wo Mandantenfähigkeit gilt, wird der Kontext serverseitig aus der Identität abgeleitet.
Abkündigung
Wird ein öffentlicher Vertrag abgekündigt, wird er benannt, getestet und mit einem nachvollziehbaren Migrationspfad versehen.