diff --git a/docs/konnectors/egl.md b/docs/konnectors/egl.md index 68be63c0f0824a23d5875e5fcbf83618b8afc7a2..044189814c439473a0b8a2f6d9826ddccb23dafe 100644 --- a/docs/konnectors/egl.md +++ b/docs/konnectors/egl.md @@ -2,6 +2,7 @@ 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](https://forge.grandlyon.com/web-et-numerique/llle_project/egl-konnector). You should also check Cozy's official documentations for konnectors : @@ -40,7 +41,7 @@ Authentication Route : **/connect.asp** } ``` -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. +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. ```json { @@ -59,18 +60,7 @@ In order to get data from the EGL API we have to request the following route : Method : **POST** -Authentication Route : **/getAllAgregatsByAbonnement.aspx** - -```json -"body": -{ - "mode": "formdata" - { - "login": <your-login>, - "pass": <your-password> - } -} -``` +Data Route : **/getAllAgregatsByAbonnement.aspx** ```json @@ -88,7 +78,7 @@ Authentication Route : **/getAllAgregatsByAbonnement.aspx** 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. +The answer will provide you an array of data day by day with the value got by the water meter 'ValeurIndex' at this moment. ```json { @@ -109,16 +99,15 @@ There answer will provides you an array of data day by day with the value got by } ``` -You'll have to subtract a day value with the previous's to get a consumption for a given day. - +Daily data is calculated by substracting current valeurIndex day with previous day. ### TypeAgregats -- "R", means the real value -- "A", means an anomaly -- "D", means a water meter changing -- "V" -- "X" -- "T", means pending data +- "R" means the real value +- "A" means an anomaly +- "D" means a water meter changing +- "V" means data has been estimated on a period +- "X" marks the start and end of "V" estimated data +- "T" means pending data If you're looking for more information about the API, checkout the [complete API documentation](/documents/egl-api-doc.pdf) diff --git a/docs/konnectors/grdf.md b/docs/konnectors/grdf.md index 2c122d38db57e2c974248acaa3c16c614e2b8839..b1eab9b8de63363add07016e0fdbe118d5b65595 100644 --- a/docs/konnectors/grdf.md +++ b/docs/konnectors/grdf.md @@ -7,7 +7,7 @@ You should also check Cozy's official documentations for konnectors : ## Grdf Adict Konnector -The Oauth protocol does not take place in the konnector code, therefore it is also important to take a look at the [proxy](/proxy/description.md) to fully understand all the interactions that will be told below. +The Oauth protocol does not take place in the konnector code, therefore it is also important to take a look at the [proxy](/proxy/description.md) documentation to fully understand all the interactions that will be told below. All the actions performed by the stack are targetted from pre-registered paramaters, here is the list of all parameters needed by the stack to perform the Oauth protocol and allow the konnector to fetch data.