esup-multi.js

A simple wrapper to interact with the internal esup-multi API.

Important

This package is not affiliated with any institutions and is not officially supported by any institutions. I am not responsible for any misuse of this package. This package is intended to help students and staff to interact with the internal API of the Multi.

📦 Installation

# With npm
npm install multi-api.js
# With pnpm
pnpm add multi-api.js
# With yarn
yarn add multi-api.js

🔧 Usage

Authentification with credentials

const { authWithCredentials } = require("esup-multi.js");

async function login(instanceUrl, username, password) {
    const user = await authWithCredentials(instanceUrl, { username, password });
    return user;
}

login("https://example.com", "multi", "api")
    .then(user => console.log(user))
    .catch(error => console.error(error));

main('username', 'password');

✅ Features

• 🔐 Connection

  • With credentials
  • With refresh token

• 📰 Actualities

• 💳 Cards

• 🕘 Clocking

• 📒 Contacts

• 🪪 Features authorization

• 📯 Important news

• 🗺️ Maps

  • Campus
  • Categories
  • Points of interest

• 📅 Personal calendars

• 🍴 Restaurants

  • General information
  • Menus

• 📅 Schedule

• 🔑 SSO Connection (via CAS for external services)

• ✉️ Unread messages count

• 🫴 Useful information

• 👨 User information

PS: Features are dependent of your institution's configuration.

📜 License

This project is licensed under the CeCILL 2.1 License - see the LICENSE file for details.

🙏 Acknowledgments

• Université de Lorraine for esup-multi.
• UPHF (Université Polytechnique Haut-de-France) for the account.
• Raphaël (raphckrman) for the structure of the library.

📧 Contact

If you have any questions, feel free to contact me at tom.theret@uphf.fr.