0-index.md

---
slug: introduction
---

# Introduction

Konnectors are scripts that import data from a web service and put those data into cozy. Each konnector is an independent application managed by the cozy home application.

Ecolyo uses data from 3 web services :

- Enedis
- Grdf
- Eau du grand Lyon (EGL)

All the konnectors are configured to retrieve user's data as far as 3 years back.
Some variation have to be considered :

- When the user launches the konnector manually, it fetches 1 year of data (in order to reduce running time).
- When a konnector is launched by the cozy stack (at a random time between 7am and 10am), it fetches 3 years of data.
- When a konnector retrieves a load at the half-hour timeline (ex: enedis), it fetches back to 4 weeks.

## Documentation

- Checkout the [konnector doc](https://docs.cozy.io/en/cozy-konnector-libs/) from cozy
- Error mapping messages displayed to users [here](https://github.com/cozy/cozy-libs/blob/983f5dc73e50f4a35dab401040c969477e4128ea/packages/cozy-harvest-lib/src/locales/en.json#L124-L207)

## ![gitlab](/img/gitlab-logo.svg) Repositories

- [enedis dataconnect (deprecated)](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-konnector)
- [enedis sge](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector)
- [grdf](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector)
- [egl](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector)

## Working with konnectors locally

### Cozy resources

Please see also the [official cozy documentation](https://docs.cozy.io/en/cozy-konnector-libs/).

### Run a konnector locally

To develop a konnector or test it, you will need to be able to run a konnector without the constraints imposed by the cozy stack.

To help you, cozy developed a **standalone** mode for konnectors.
Simply launch it by typing:

`yarn standalone`

This command will create a **konnector-dev-config.json** file if it was not in your project folder before.
This file needs to hold all the information transmitted by the cozy stack when the konnector runs by default

- baseUrl
- apiAuthKey
- login
- password and so on...

Type them all in the *fields* object.

All data recovered by the standalone konnector will be stored in the *data* folder.