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 given here are obtained with the demo version. For your own use, please adapt the queries with your access and adequate URIs.

We provide two URLs which allow you to authenticate and access your measures remotely:

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 : tous les exemples présentés ici sont issus de la version de démonstration. Pour votre propre usage, merci d’adapter les requêtes avec vos accès et les URIs appropriées.

Nous mettons à disposition deux URLs qui vous permettent de vous authentifier et d’accéder à vos mesures à distance :

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

Before you can get measures with the API, you need to authenticate with the Login API to obtain a valid access token.

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

Authentification

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, you can use all the endpoints described in the GetMeasure API catalog to extract your data:

  • 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 extraire vos données :

  • 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).