{"id":15007697,"url":"https://github.com/tom-theret/uphf-api","last_synced_at":"2025-10-30T11:31:56.667Z","repository":{"id":257791934,"uuid":"857461198","full_name":"tom-theret/uphf-api","owner":"tom-theret","description":"A simple wrapper to interact with the internal UPHF (Université Polytechnique Haut-de-France) API","archived":false,"fork":false,"pushed_at":"2024-10-10T22:08:28.000Z","size":132,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-10T22:44:59.085Z","etag":null,"topics":["api-rest","education","npm-package","reverse-engineering","university","uphf"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/uphf-api","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tom-theret.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"tom-theret"}},"created_at":"2024-09-14T18:09:03.000Z","updated_at":"2024-10-10T22:07:10.000Z","dependencies_parsed_at":"2024-09-28T15:20:53.369Z","dependency_job_id":null,"html_url":"https://github.com/tom-theret/uphf-api","commit_stats":null,"previous_names":["tom-theret/uphf-api"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-theret%2Fuphf-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-theret%2Fuphf-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-theret%2Fuphf-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-theret%2Fuphf-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tom-theret","download_url":"https://codeload.github.com/tom-theret/uphf-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219856362,"owners_count":16556084,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","education","npm-package","reverse-engineering","university","uphf"],"created_at":"2024-09-24T19:13:26.446Z","updated_at":"2025-10-30T11:31:56.213Z","avatar_url":"https://github.com/tom-theret.png","language":"TypeScript","funding_links":["https://github.com/sponsors/tom-theret"],"categories":[],"sub_categories":[],"readme":"# uphf-api\n\n# ⚠️ upht-api -\u003e [esup-multi.js](https://github.com/tom-theret/esup-multi.js) ⚠️\n\nA simple wrapper to interact with the internal UPHF (Université Polytechnique Haut-de-France) API\n\n![NPM Version](https://img.shields.io/npm/v/uphf-api)\n![NPM Downloads](https://img.shields.io/npm/dy/uphf-api)\n![NPM License](https://img.shields.io/npm/l/uphf-api)\n\n\u003e [!important]\n\u003e 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.\n\n## 📦 Installation\n\n```bash\n# With npm\nnpm install uphf-api\n# With pnpm\npnpm add uphf-api\n# With yarn\nyarn add uphf-api\n```\n\n## 🔧 Usage\n\n### Authentification with credentials\n\n```javascript\nconst UPHF = require('uphf-api');\n\nasync function main(username, password) {\n    let client = await UPHF.authWithCredentials({\n        username: username,\n        password: password\n    });\n\n    console.log(client);\n}\n\nmain('username', 'password');\n```\n\nYou can view other examples in the [examples](https://github.com/tom-theret/uphf-api/examples) folder.\n\n## ✅ Features\n\n- [x] 🔐 Connection\n  - [x] With credentials\n  - [x] With refresh token\n\n- [x] 📰 Actualities\n- [x] 📒 Contacts\n- [x] 🪪 Features authorization\n- [x] 📯 Important news\n- [x] 🗺️ Maps\n  - [x] Campus\n  - [x] Categories\n  - [x] Points of interest\n- [x] 📅 Personal calendars (Zimbra calendars)\n- [x] 🍴 Restaurants\n  - [x] General information\n  - [x] Menus\n- [x] 📅 Schedule\n- [x] 🔑 SSO Connection (via CAS for external services)\n- [x] ✉️ Unread messages count (Zimbra mailbox)\n- [x] 🫴 Useful information\n- [x] 👨 User information\n\n## 📜 License\n\nThis 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.\n\n## 📝 Contributing\n\nPlease 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.\n\n## 🙏 Acknowledgments\n\n- [UPHF (Université Polytechnique Haut-de-France)](https://www.uphf.fr/) for the API and account.\n- [Raphaël (raphckrman)](https://github.com/raphckrman) for the structure of the library.\n\n## 📧 Contact\n\nIf you have any questions, feel free to contact me at [tom.theret@uphf.fr](mailto:tom.theret@uphf.fr).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftom-theret%2Fuphf-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftom-theret%2Fuphf-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftom-theret%2Fuphf-api/lists"}