https://github.com/tom-theret/esup-multi.js
A simple wrapper to interact with the internal esup-multi API.
https://github.com/tom-theret/esup-multi.js
api esup insa lorraine unimes university uphf wrapper
Last synced: about 2 months ago
JSON representation
A simple wrapper to interact with the internal esup-multi API.
- Host: GitHub
- URL: https://github.com/tom-theret/esup-multi.js
- Owner: tom-theret
- License: cecill-2.1
- Created: 2024-11-01T23:21:17.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T16:16:01.000Z (5 months ago)
- Last Synced: 2025-04-12T12:13:23.868Z (about 2 months ago)
- Topics: api, esup, insa, lorraine, unimes, university, uphf, wrapper
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/esup-multi.js
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# esup-multi.js
A simple wrapper to interact with the internal [esup-multi](https://github.com/univlorraine/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
```bash
# With npm
npm install esup-multi.js
```
## 🔧 Usage
### Authentification with credentials
```javascript
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
- [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](https://github.com/tom-theret/esup-multi.js?tab=CECILL-2.1-1-ov-file) file for details.
## 🙏 Acknowledgments
- [Université de Lorraine](https://www.univ-lorraine.fr/) for [esup-multi](https://github.com/univlorraine/esup-multi/).
- [UPHF (Université Polytechnique Haut-de-France)](https://www.uphf.fr/) for the account.
- [Raphaël (raphckrman)](https://github.com/raphckrman) for the structure of the library.
## 📧 Contact
If you have any questions, feel free to contact me at [[email protected]](mailto:[email protected]).