Introduction

Here, we present the way to use the API “GetMeasure V2”. This REST API is developed to get measures from the data warehouse.

Remark: All examples shown in this documentation are based on the demo environment. For your usage, requests must be adapted using the URIs provided by the support service, along with your own access credentials.

Two demo URLs are provided to allow authentication and access to measurement data from the demonstration environment.

Demo credentials

For the demo version, you can use:

  • Login: demo
  • Password: demo
  • Application name: getmeasure (this parameter is fixed)

Introduction

Nous présentons ici la manière d’utiliser l’API « GetMeasure V2 ». Cette API REST permet de récupérer les mesures depuis l’entrepôt de données.

Remarque : All examples shown in this documentation are based on the demo environment. For actual usage, requests must be adapted using the URIs provided by the support service, along with your own access credentials.

Deux URLs de démonstration sont mises à disposition afin de permettre l’authentification et l’accès aux mesures de l’environnement de démonstration.

Identifiants de démonstration

Pour la version de démonstration, vous pouvez utiliser :

  • Login : demo
  • Mot de passe : demo
  • Nom d’application : getmeasure (ce paramètre est fixe)

Authentication

For testing and onboarding purposes, please use the demo URIs provided in this documentation. For production usage, the API must be accessed using the URIs supplied by the support service.

Before accessing measurement data, authentication is required through the Login API in order to obtain a valid access token.

Use your login and password with the requests defined in the Login API catalog (see the /login endpoint in the Swagger section below).

Authentification

Pour les phases de test et de prise en main, veuillez utiliser les URI de démonstration fournies dans cette documentation. Pour un usage en production, l’accès à l’API doit se faire via les URI fournies par le service support.

Avant de pouvoir récupérer des mesures avec l’API, vous devez vous authentifier via l’API de Login afin d’obtenir un jeton d’accès valide.

Utilisez votre login et votre mot de passe avec les requêtes définies dans le catalogue de l’API de Login (endpoint /login dans la section Swagger ci-dessous).

Measures access

Once authenticated, all endpoints described in the GetMeasure API catalog can be used to retrieve data, using the demo URIs for testing or the production URI supplied by the support service.

  • Site list, entities and opening hours: /rpc/get_site and /rpc/get_entity_analyzed /rpc/get_daily_opening_hours
  • New endpoints (V2) to retrieve measures: /rpc/get_measures_by_site and /rpc/get_measures_by_entity
  • Deprecated endpoints kept for backward compatibility (see the Deprecated section in Swagger).

Accès aux mesures

Une fois authentifié, vous pouvez utiliser l’ensemble des endpoints décrits dans le catalogue de l’API GetMeasure pour accéder à vos données, soit via les URI de démonstration pour les tests, soit via les URI de production mises à votre disposition.

  • Liste des sites, des entités et des horaires d'ouvertures: /rpc/get_site et /rpc/get_entity_analyzed /rpc/get_daily_opening_hours
  • Nouveaux endpoints (V2) pour récupérer les mesures : /rpc/get_measures_by_site et /rpc/get_measures_by_entity
  • Endpoints dépréciés conservés pour compatibilité ascendante (voir la section Deprecated dans Swagger).