Scopes

Contexte

L'API Scopes fournit des informations sur les ressources et endpoints de l'API accessibles avec votre clé API. Cela vous permet de comprendre les permissions actuelles de votre clé API et de découvrir les données que vous pouvez récupérer.

Endpoints disponibles

• GET /scopes - Récupérer les scopes disponibles et les endpoints accessibles avec votre clé API

Données

L'endpoint scopes retourne un tableau d'objets scope, chacun représentant une ressource à laquelle vous avez accès.

Champ	Type	Description
scope	string	Nom de la ressource (par ex. site-configuration)
paths	string[]	Tableau des chemins d'endpoints API auxquels vous avez accès

Scopes disponibles

Scope	Description	Endpoints inclus
site-configuration	Accès aux données de configuration des sites et des bornes	/rest/v1/sites
ocpp-logs	Accès aux journaux et diagnostics du protocole OCPP	/rest/v1/ocpp-logs
charging-sessions	Accès aux données historiques des événements de charge	/rest/v1/charging-events

Endpoints par défaut

Les endpoints suivants sont toujours inclus dans vos scopes :

• /rest/v1/ping - Endpoint de vérification de disponibilité
• /rest/v1/scopes - Cet endpoint

Exemple de réponse

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