Aller au contenu

papillon-ed-core

papillon-ed-core est un module de base pour l'application Papillon. Il contient des classes et des fonctions qui sont utilisées pour récupérer des données, les envoyer à IndexDataInstance pour les afficher.

Installation

Node Package Manager

Le module est disponible sur npmjs.com sous le nom de papillon-ed-core.

Le répo du module est disponible sur Github .

Documentation

Sommaire

Installation

npm i papillon-ed-core

Note Vous pouvez installer une version spécifique du module via la commande suivante :

npm i papillon-ed-core@<version>

Fonctions

auth

L'étape suivante consiste à se connecter avec un compte EcoleDirecte existant. Pour cela, deux moyens :

login()

Description:
Permet de se connecter à EcoleDirecte avec des identifiants.

Paramètres:

login("identifiant", "mot de passe")

Exemple:

const ED = require("Papillon-ED-Core")
ED.auth.login("identifiant", "mot de passe").then(() => {
    let token = ed._token;
    let prenom = ed.student.prenom

    // ...
})
.catch(err => { //en cas d'erreur à la connexion
    console.log(err)
})
setToken()

Description:

Permet de se connecter à EcoleDirecte avec un token déjà généré.

Paramètres:

setToken("token", userID)

Exemple:

const ED = require("Papillon-ED-Core")
let ed = new ED()

ed.auth.setToken("token", userID)

//...