parcoursup-api
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

Parcoursup

Support non-officiel de l'API mobile Parcoursup
La librairie ne permet pas d'accepter une proposition d'admission ou de démissionner d'un vœu (par mesure de sécurité).
Il est néanmoins possible d'observer l'évolution des indicateurs pour chaque vœu formulé.

Kind: global class

new Parcoursup(username, password, appareil)

Param Type Description
username string Numéro de dossier
password string Mot de passe
appareil Appareil Informations sur le terminal mobile

Example

const { Parcoursup } = require('parcoursup-api')

const numeroDossier = '000000'
const motDePasseDossier = 'test'
const appareil = {
    plateforme: 'android',
    plateformeVersion: '10.0',
    appVersion: '2.1.7',
    uuid: `psup${Date.now()}`, // Identifiant aléatoire pour chaque appareil
    modele: 'PSUP-API',
    session: 2022
}
const candidat = new Parcoursup(numeroDossier, motDePasseDossier, appareil)

parcoursup.getVoeux()

Détail des vœux formulés sur la plateforme avec le détail de leur statut

Kind: instance method of Parcoursup

parcoursup.getVoeu(voeuId)

Détail d'un vœu

Kind: instance method of Parcoursup

Param Type Description
voeuId string Identifiant du vœu

parcoursup.getCompteursMenu()

Compteurs du candidat :

  • Nombre de propositions d'admission
  • Nombre de vœux en attente
  • Nombre de vœux formulés
  • Nombre de messages non lus

Kind: instance method of Parcoursup
Example

const candidat = new Parcoursup(numeroDossier, motDePasseDossier, appareil)
candidat.getCompteursMenu().then(({counts}) => {
    console.log(`Le dossier contient ${counts.propositions} propositions et ${counts.enAttente} voeux en attente pour un total de ${counts.total} voeux formulés.`)
})

parcoursup.getMessages(full)

Boîte de messagerie du candidat

Kind: instance method of Parcoursup

Param Type Default
full boolean true

Parcoursup.login(username, password, appareil)

Obtenir des jetons d'authentification

Kind: static method of Parcoursup

Param Type Description
username string Numéro de dossier
password string Mot de passe
appareil Appareil Informations sur l'appareil mobile utilisé

Readme

Keywords

Package Sidebar

Install

npm i parcoursup-api

Weekly Downloads

0

Version

1.0.2

License

GPL-3.0

Unpacked Size

53.7 kB

Total Files

18

Last publish

Collaborators

  • maelgangloff