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

• [x] 🔐 Connection

  • [x] With credentials
  • [x] With refresh token

• [x] 📰 Actualities

• [x] 💳 Cards

• [x] 🕘 Clocking

• [x] 📒 Contacts

• [x] 🪪 Features authorization

• [x] 📯 Important news

• [x] 🗺️ Maps

  • [x] Campus
  • [x] Categories
  • [x] Points of interest

• [x] 📅 Personal calendars

• [x] 🍴 Restaurants

  • [x] General information
  • [x] Menus

• [x] 📅 Schedule

• [x] 🔑 SSO Connection (via CAS for external services)

• [x] ✉️ Unread messages count

• [x] 🫴 Useful information

• [x] 👨 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 [email protected].