egl.md

!!! info "" 🚧 Section under Construction 🚧

EGL Konnector

This konnector fetches consumptions measures from EGL API. The EGL API allows us to get a user's consumption data gathered by it's connected water meter "Téléo". You can clone the project here.

You should also check Cozy's official documentations for konnectors : https://docs.cozy.io/en/tutorials/konnector/getting-started/

API Url for Development : https://agence-rec.eaudugrandlyon.com

API Url for Production : https://agence.eaudugrandlyon.com/ws

Authentication

In order to authenticate to the EGL API we have to request the following route

Method : POST

Authentication Route : /connect.asp

"headers":
{
	{
		"AuthKey": <your-auth-key>,
		"Content-Type": "application/x-www-form-urlencoded"
	}
}

"body":
{
	"mode": "formdata"
	{
		"login": <your-login>,
		"pass": <your-password>
	}
}

Once you've sent this request the API should answer with a code 100 if everything is ok and provides you a valid token and num_abt that you will use later in order to get data.

{
  "codeRetour": 100,
  "libelleRetour": "Connecté",
  "resultatRetour": {
    "num_abt": 1895683,
    "token": "897555754A703055397897456568776E32704C3953514F5R"
  }
}

Fetch Data

In order to get data from the EGL API we have to request the following route :

Method : POST

Authentication Route : /getAllAgregatsByAbonnement.aspx

"body":
{
	"mode": "formdata"
	{
		"login": <your-login>,
		"pass": <your-password>
	}
}

"body":
{
	"mode": "formdata"
	{
		"token": "897555754A703055397897456568776E32704C3953514F5R",
		"num_abt": 1895683,
		"date_debut": MM/JJ/YYYY,
		"date_fin": MM/JJ/YYYY
	}
}

The dates must be valid dates otherwise you'll get an error

There answer will provides you an array of data day by day with the value got by the water meter 'ValeurIndex' at this moment.

{
  "codeRetour": 100,
  "libelleRetour": "L'opération a réussi",
  "resultatRetour": [
    {
      "DateReleve": "2020-07-01T00:00:00+02:00",
      "TypeAgregat": "R",
      "ValeurIndex": 562362
    },
    {
      "DateReleve": "2020-07-02T00:00:00+02:00",
      "TypeAgregat": "R",
      "ValeurIndex": 562432
    }
  ]
}

You'll have to subtract a day value with the previous's to get a consumption for a given day.

TypeAgregats

• "R", means the real value
• "A", means an anomaly
• "D", means a water meter changing
• "V"
• "X"
• "T", means pending data

If you're looking for more information about the API, checkout the complete API documentation

Usage

TODO : add explanation of how we manage data in the konnector