1.0.4 โข Published 6 months ago
esup-multi.js v1.0.4
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 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
- 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.