An open API service indexing awesome lists of open source software.

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.

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.

![NPM Version](https://img.shields.io/npm/v/esup-multi.js)
![NPM Downloads](https://img.shields.io/npm/dy/esup-multi.js)
![NPM License](https://img.shields.io/npm/l/esup-multi.js)

> [!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]).