kdecole-api v1.4.7

kdecole-api

Support non officiel de l'API Kdecole (Mon Bureau Numérique, Skolengo, etc.).

Ce module permet de récupérer les données de l'ENT de manière automatique. De plus, certaines fonctions implémentées permettent de prétraiter les données (conversion de l'emploi du temps au format iCalendar, export du relevé de notes au format CSV par exemple).

Cette librairie est destinée à être dépréciée au profit de scolengo-api dans l'éventualité où l'accès à l'ancienne API est définitivement clos.

Pour participer et se tenir informé, rejoins le serveur Discord: https://discord.gg/9u69mxsFT6

Remarques importantes:

• Il est clairement mentionné que cette librairie est n'est pas officielle.
• Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement.
• Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'application.
• Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de Skolengo.
• Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences.
• Tout utilisateur de cette librairie a a priori lu l'entièreté du fichier de licence GPLv3 disponible publiquement LICENSE ainsi que de ce présent fichier de présentation.
• Tout utilisateur de cette librairie a a priori lu l'entièreté du code de ce projet avant toute utilisation.
• Eu égard l'ensemble de ces remarques, les contributeurs et a fortiori l'auteur du projet ne peuvent être tenus comme responsables de tout dommage potentiel.

L'accès à l'API requiert une en-tête (header) avec la version de l'application en cours d'utilisation.

Le terme "code" ou "password" ne réfère pas ici à votre mot de passe, mais à un code temporaire généré par votre ENT (dans paramètres > application mobile). C'est comme cela que fonctionne l'authentification à l'API.

Liste des ENT supportés :

Une autre méthode pour obtenir un token est d'utiliser la ligne de commande:

npx kdecole-api -u USERNAME -p CODE --ent PROD_MON_BUREAU_NUMERIQUE

Kdecole

Kind: global class

• kdecole-api
  • Remarques importantes:
  • Liste des ENT supportés :
  • Kdecole
    • new Kdecole(authToken, apiVersion, idEtablissement, apiURL)
    • kdecole.logout() ⇒ Promise.\<void>
    • kdecole.starting() ⇒ Promise.\<void>
    • kdecole.getReleve(idEleve) ⇒ Promise.\<Releve>
    • kdecole.getActualites(idEleve) ⇒ Promise.\<Array.\<Actualite>>
    • kdecole.getContenuArticle(uid) ⇒ Promise.\<ContenuArticle>
    • kdecole.getContenuInformation(uid) ⇒ Promise.\<ContenuArticle>
    • kdecole.getTravailAFaire(idEleve, notBeforeDate) ⇒ Promise.\<TravailAFaire>
    • kdecole.getContenuActivite(uidSeance, uid, idEleve) ⇒ Promise.\<ContenuActivite>
    • kdecole.setActiviteFinished(uidSeance, uid, flagRealise) ⇒ Promise.\<void>
    • kdecole.getAbsences(idEleve) ⇒ Promise.\<AbsencesList>
    • kdecole.getInfoUtilisateur(idEleve) ⇒ Promise.\<Utilisateur>
    • kdecole.getCalendrier(idEleve) ⇒ Promise.\<Calendrier>
    • kdecole.getNotes(idEleve) ⇒ Promise.\<NotesList>
    • kdecole.getMessagerieInfo() ⇒ Promise.\<MessageInfo>
    • kdecole.getMessagerieBoiteReception(pagination) ⇒ Promise.\<MessageBoiteReception>
    • kdecole.getCommunication(id) ⇒ Promise.\<Communication>
    • kdecole.reportCommunication(id) ⇒ Promise.\<void>
    • kdecole.deleteCommunication(id) ⇒ Promise.\<void>
    • kdecole.setCommunicationLu(id) ⇒ Promise.\<void>
    • kdecole.sendMessage(id, corpsMessage) ⇒ Promise.\<void>
    • kdecole.gestionAppels() ⇒ Promise.\<GestionAppels>
    • kdecole.validerAppel(appel) ⇒ Promise.\<void>
    • Kdecole.login(username, password, apiVersion, apiUrl) ⇒ Promise.\<string>

new Kdecole(authToken, apiVersion, idEtablissement, apiURL)

Example

const { Kdecole, ApiVersion, ApiUrl } = require('kdecole-api');

const token = 'azertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazertyuiopazert'
const user = new Kdecole(token, ApiVersion.PROD_MON_BUREAU_NUMERIQUE, 0, ApiUrl.PROD_MON_BUREAU_NUMERIQUE)
user.getInfoUtilisateur().then(infoUser => {
  console.log(`Jeton valide, connecté en tant que ${infoUser.nom}.`)
})

kdecole.logout() ⇒ Promise.<void>

Révoque le jeton d'accès

Kind: instance method of Kdecole
Example

const { Kdecole } = require('kdecole-api')
const user = new Kdecole(authToken)
user.logout()

kdecole.starting() ⇒ Promise.<void>

Ping à l'API. Cet appel est initialement réalisé par l'application mobile pour vérifier si le token et la version de l'app sont valides. Le serveur retourne un code de statut HTTP 204 No Content si l'utilisateur est correctement authentifié.

Kind: instance method of Kdecole
Example

const { Kdecole } = require('kdecole-api')
const user = new Kdecole(authToken)
try {
  user.starting()
}
catch (e) {
  // Une exception est levée si l'utilisateur n'est pas correctement authentifié
}

kdecole.getReleve(idEleve) ⇒ Promise.<Releve>

Retourne le relevé de notes de l'élève

Kind: instance method of Kdecole

Example

kdecole.getReleve() //Retourne le relevé de l'élève
kdecole.getReleve(idEleve) //Retourne le relevé d'un élève précis

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getReleve(idEleve).then(releve => {
 // Votre code
 releve.toCSV() // Exporter son relevé des notes dans un objet contenant les devoirs au format CSV
 })

kdecole.getActualites(idEleve) ⇒ Promise.<Array.<Actualite>>

Retourne un tableau des actualités de l'établissement de l'utilisateur

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getActualites(idEleve).then(actualites => {
 // Votre code
 })

kdecole.getContenuArticle(uid) ⇒ Promise.<ContenuArticle>

Retourne le contenu d'un article Un article est publié par l'établissement.

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getContenuArticle(uid).then(contenuArticle => {
 // Votre code
 })

kdecole.getContenuInformation(uid) ⇒ Promise.<ContenuArticle>

Retourne le contenu d'une information Une information est publiée par la plateforme EMS.

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getContenuInformation(uid).then(contenuInformation => {
 // Votre code
 })

kdecole.getTravailAFaire(idEleve, notBeforeDate) ⇒ Promise.<TravailAFaire>

Retourne la liste des devoirs de l'élève

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getTravailAFaire(idEleve).then(taf => {
 // Votre code
 })

kdecole.getContenuActivite(uidSeance, uid, idEleve) ⇒ Promise.<ContenuActivite>

Retourne les détails d'un devoir à faire

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getContenuActivite(uidSeance, uid, idEleve).then(contenuActivite => {
 // Votre code
 })

kdecole.setActiviteFinished(uidSeance, uid, flagRealise) ⇒ Promise.<void>

Permet de marquer un devoir comme étant fait

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.setActiviteFinished(uidSeance, uid, flagRealise)

kdecole.getAbsences(idEleve) ⇒ Promise.<AbsencesList>

Retourne la liste des absences d'un élève

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getAbsences(idEleve).then(absences => {
 // Votre code
 })

kdecole.getInfoUtilisateur(idEleve) ⇒ Promise.<Utilisateur>

Retourne les informations d'un utilisateur (type de compte, nom complet, numéro de l'établissement, etc.)

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getInfoUtilisateur(idEleve).then(infoUtilisateur => {
 // Votre code
 })

kdecole.getCalendrier(idEleve) ⇒ Promise.<Calendrier>

Retourne l'emploi du temps de l'élève à J-7 et J+7

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getCalendrier(idEleve).then(calendrier => {
 // Votre code
 })

kdecole.getNotes(idEleve) ⇒ Promise.<NotesList>

Retourne la liste des récentes notes de l'élève

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getNotes(idEleve).then(notes => {
 // Votre code
 })

kdecole.getMessagerieInfo() ⇒ Promise.<MessageInfo>

Retourne l'état de la messagerie de l'utilisateur (nombre de mails non lus)

Kind: instance method of Kdecole
Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getMessagerieInfo().then(messagerieInfo => {
 // Votre code
 })

kdecole.getMessagerieBoiteReception(pagination) ⇒ Promise.<MessageBoiteReception>

Retourne les mails présents dans la boîte mail Le paramètre pagination permet de remonter dans le passé dans la liste des fils de discussions

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getMessagerieBoiteReception().then(messagerieBoiteReception => {
 // Votre code
 })

kdecole.getCommunication(id) ⇒ Promise.<Communication>

Retourne les détails d'un fil de discussion

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.getCommunication(id).then(communication => {
 // Votre code
 })

kdecole.reportCommunication(id) ⇒ Promise.<void>

Permet de signaler une communication

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.reportCommunication(id)

kdecole.deleteCommunication(id) ⇒ Promise.<void>

Supprime la communication

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.deleteCommunication(id)

kdecole.setCommunicationLu(id) ⇒ Promise.<void>

Marquer une communication lue

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.setCommunicationLu(id)

kdecole.sendMessage(id, corpsMessage) ⇒ Promise.<void>

Envoyer un message sur un fil de discussion

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.sendMessage(id, corpsMessage)

kdecole.gestionAppels() ⇒ Promise.<GestionAppels>

Retourne les feuilles d'appel

Kind: instance method of Kdecole
Returns: Promise.<GestionAppels> - Les feuilles d'appel.
Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
user.gestionAppels().then(gestionAppels => {
 // Votre code
 })

kdecole.validerAppel(appel) ⇒ Promise.<void>

Valide l'appel de la classe

Kind: instance method of Kdecole

Example

const { Kdecole } = require('kdecole-api')

const user = new Kdecole(AUTH_TOKEN)
const appel = {
  "idEtab": 10485,
  "idAppel": 534552,
  "listeAbsencesAppel": [
    {
      "idEleve": "AAP05567",
      "type": "absence",
      "dateDebut": 1609259443000,
      "dateFin": 1609263043000,
      "modifiable": true
    }
  ]
}
user.validerAppel(appel)

Kdecole.login(username, password, apiVersion, apiUrl) ⇒ Promise.<string>

Demande à l'API de générer un nouveau jeton pour l'utilisateur

Kind: static method of Kdecole

Example

const { Kdecole, ApiUrl, ApiVersion } = require('kdecole-api')
Kdecole.login(username, uniquePassword, ApiVersion.PROD_MON_BUREAU_NUMERIQUE, ApiUrl.PROD_MON_BUREAU_NUMERIQUE).then(token => console.log(token)) // Affiche son token dans la console