Scopes

Kontext

Die Scopes API liefert Informationen darüber, welche API-Ressourcen und Endpoints mit Ihrem API-Schlüssel zugänglich sind. Dies ist hilfreich, um Ihre aktuellen API-Berechtigungen zu verstehen und herauszufinden, welche Daten Sie abrufen können.

Verfügbare Endpoints

• GET /scopes - Verfügbare Scopes und zugängliche Endpoints für Ihren API-Schlüssel abrufen

Daten

Der Scopes-Endpoint gibt ein Array von Scope-Objekten zurück, von denen jedes eine Ressource darstellt, auf die Sie Zugriff haben.

Feld	Typ	Beschreibung
scope	string	Name der Ressource (z. B. site-configuration)
paths	string[]	Array der API-Endpoint-Pfade, auf die Sie zugreifen können

Verfügbare Scopes

Scope	Beschreibung	Enthaltene Endpoints
site-configuration	Zugriff auf Standort- und Ladestation-Konfigurationsdaten	/rest/v1/sites
ocpp-logs	Zugriff auf OCPP-Protokoll-Logs und -Diagnose	/rest/v1/ocpp-logs
charging-sessions	Zugriff auf historische Ladevorgangsdaten	/rest/v1/charging-events

Standard-Endpoints

Die folgenden Endpoints sind immer in Ihren Scopes enthalten:

• /rest/v1/ping - Endpoint zur Verfügbarkeitsprüfung
• /rest/v1/scopes - Dieser Endpoint

Beispielantwort

{
  "scopes": [
    {
        "scope": "site-configuration",
        "paths": [
            "/rest/v1/sites/*"
        ]
    },
    {
        "scope": "default",
        "paths": [
            "/rest/v1/ping/*",
            "/rest/v1/scopes/*",
        ]
    }
  ]
}