1.0.4 โ€ข Published 6 months ago

esup-multi.js v1.0.4

Weekly downloads
-
License
CeCILL-2.1
Repository
github
Last release
6 months ago

esup-multi.js

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

NPM Version NPM Downloads NPM License

!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 esup-multi.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));

โœ… 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

๐Ÿ“ง Contact

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

1.0.4

6 months ago

1.0.3

8 months ago

1.0.2

9 months ago

1.0.1

9 months ago

1.0.0

9 months ago