https://github.com/tom-theret/uphf-api
A simple wrapper to interact with the internal UPHF (Université Polytechnique Haut-de-France) API
https://github.com/tom-theret/uphf-api
api-rest education npm-package reverse-engineering university uphf
Last synced: 4 months ago
JSON representation
A simple wrapper to interact with the internal UPHF (Université Polytechnique Haut-de-France) API
- Host: GitHub
- URL: https://github.com/tom-theret/uphf-api
- Owner: tom-theret
- License: gpl-3.0
- Created: 2024-09-14T18:09:03.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-10T22:08:28.000Z (8 months ago)
- Last Synced: 2024-10-10T22:44:59.085Z (8 months ago)
- Topics: api-rest, education, npm-package, reverse-engineering, university, uphf
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/uphf-api
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# uphf-api
# ⚠️ upht-api -> [esup-multi.js](https://github.com/tom-theret/esup-multi.js) ⚠️
A simple wrapper to interact with the internal UPHF (Université Polytechnique Haut-de-France) API
> [!important]
> This package is not affiliated with the UPHF (Université Polytechnique Haut-de-France) and is not officially supported by the institution. 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 UPHF.
## 📦 Installation
```bash
# With npm
npm install uphf-api
# With pnpm
pnpm add uphf-api
# With yarn
yarn add uphf-api
```
## 🔧 Usage
### Authentification with credentials
```javascript
const UPHF = require('uphf-api');
async function main(username, password) {
let client = await UPHF.authWithCredentials({
username: username,
password: password
});
console.log(client);
}
main('username', 'password');
```
You can view other examples in the [examples](https://github.com/tom-theret/uphf-api/examples) folder.
## ✅ Features
- [x] 🔐 Connection
- [x] With credentials
- [x] With refresh token
- [x] 📰 Actualities
- [x] 📒 Contacts
- [x] 🪪 Features authorization
- [x] 📯 Important news
- [x] 🗺️ Maps
- [x] Campus
- [x] Categories
- [x] Points of interest
- [x] 📅 Personal calendars (Zimbra calendars)
- [x] 🍴 Restaurants
- [x] General information
- [x] Menus
- [x] 📅 Schedule
- [x] 🔑 SSO Connection (via CAS for external services)
- [x] ✉️ Unread messages count (Zimbra mailbox)
- [x] 🫴 Useful information
- [x] 👨 User information
## 📜 License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://github.com/tom-theret/uphf-api/LICENSE) file for details.
## 📝 Contributing
Please read [CONTRIBUTING.md](https://github.com/tom-theret/uphf-api/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## 🙏 Acknowledgments
- [UPHF (Université Polytechnique Haut-de-France)](https://www.uphf.fr/) for the API and 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]).