https://github.com/matt0550/registroarchimede-api-docs
All the information about the endpoints of the Registro Archimede App.
https://github.com/matt0550/registroarchimede-api-docs
api api-docs documentation registro-archimede
Last synced: 5 months ago
JSON representation
All the information about the endpoints of the Registro Archimede App.
- Host: GitHub
- URL: https://github.com/matt0550/registroarchimede-api-docs
- Owner: Matt0550
- License: gpl-3.0
- Created: 2024-09-11T17:26:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T22:48:43.000Z (about 1 year ago)
- Last Synced: 2025-02-12T06:02:08.257Z (12 months ago)
- Topics: api, api-docs, documentation, registro-archimede
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![MIT License][license-shield]][license-url]
[![Discord][discord-shield]][discord-url]
Registro Archimede Unofficial API DOCS
All the information about the endpoints of the Registro Archimede App.
Contribute
All the information about the endpoints of the Registro Archimede App.
The endpoints was discovered using [HTTP toolkit](https://httptoolkit.com/)
(or [MITM Proxy](https://mitmproxy.org/)) and the app on rooted Android Emulator with Android 14 (API 35). Rooted with [Magisk](https://magiskmanager.com/) to bypass certificate pinning.
This project is for educational purposes only. Please use this project responsibly.
Copyright and all rights belong to the respective owners.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [API Endpoints](#api-endpoints)
- [Base URL](#base-url)
- [Authentication](#authentication)
- [Login/User Info](#loginuser-info)
- [Logout](#logout)
- [Student Area (Alunno) (Login required)](#student-area-alunno-login-required)
- [Subscription type](#subscription-type)
- [Absences list](#absences-list)
- [Subjects list](#subjects-list)
- [Grades list](#grades-list)
- [Delays and permits list](#delays-and-permits-list)
- [Homework list](#homework-list)
- [Arguments list](#arguments-list)
- [Messages list](#messages-list)
- [Read message](#read-message)
- [Download attachment](#download-attachment)
- [Discipline notes list](#discipline-notes-list)
- [Teacher communication list](#teacher-communication-list)
- [Documents list](#documents-list)
- [Document download](#document-download)
- [Teachers' bulletin board](#teachers-bulletin-board)
- [FAD (Formazione a Distanza) list](#fad-formazione-a-distanza-list)
- [Video conferences list](#video-conferences-list)
- [Received notifications list](#received-notifications-list)
- [Misc](#misc)
- [Register firebase token (login required)](#register-firebase-token-login-required)
- [Help - feedback](#help---feedback)
- [License](#license)
- [Support me](#support-me)
## API Endpoints
>[!WARNING]
> All listed JSON responses are given only when a request is successful. If a request fails the response may be in html or with an error code (not tested).
### Base URL
```
https://app.registroarchimede.it/archimede/seam/resource/rest
```
### Authentication
#### Login/User Info
```
POST /loginRest/login
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `username` | `string` | **Required**. Your username |
| `password` | `string` | **Required**. Your password |
| `tokenFirebase` | `string` | (Optional) Your Firebase token (i don't know what is this) |
**JSON Response**
```json
{
"classe": "",
"visualizzaAlternzanzaScuolaLavoro": true,
"cognome": "",
"visualizzaAssenze": true,
"visualizzaVoti": true,
"roles": [
{
"role": "Alunno"
}
],
"visualizzaCertificazioneComp": true,
"nome": "",
"trimestre": true,
"primaria": true,
"giustificaFamiglia": true,
"visualizzaCompitiArgomenti": true,
"soloFad": true,
"visualizzaComunicazioni": true,
"giustificaConPin": true,
"scuola": "",
"sesso": "",
"visualizzaNoteDisciplinari": true,
"visualizzaRiepilogoAssenze": true,
"visualizzaArgomenti": true
}
```
#### Logout
```
GET /loginRest/logout
```
**JSON Response**
```json
{
"ok": "ok"
}
```
### Student Area (Alunno) (Login required)
> [!IMPORTANT]
> Before using these endpoints, you need to login with the `Login/User Info` endpoint. A cookie (`JSESSIONID`) will be set in your browser.
#### Subscription type
```
GET /AreaAlunno/tipoAbbonamento/{firebaseToken}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `firebaseToken` | `string` | **Required**. Your Firebase token |
**JSON Response**
```json
{
"stato": "archimede_2024.25"
}
```
#### Absences list
```
GET /AreaAlunno/assenze/{period}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `period` | `int` | **Required**. The period of the absences (`0` or `1`) |
**JSON Response**
> Not available yet
#### Subjects list
```
GET /AreaAlunno/materie/
```
**JSON Response**
```json
[
{
"descrizione": "",
"corso_id": 123,
"docente": null,
"img_docente": "base64"
},
]
```
#### Grades list
```
GET /AreaAlunno/voti/{corsoId}/{period}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `corsoId` | `int` | **Required**. The course id. `-1` for all courses |
| `period` | `int` | **Required**. The period of the grades (`0` or `1`) |
**JSON Response**
> Not available yet
#### Delays and permits list
```
GET /AreaAlunno/ritardiPermessi/
```
**JSON Response**
> Not available yet
#### Homework list
```
GET /AreaAlunno/compiti/{corsoId}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `corsoId` | `int` | **Required**. The course id. `-1` for all courses |
**JSON Response**
```json
[
{
"data": "yyyy-MM-dd",
"materia": "",
"compito": ""
}
]
```
#### Arguments list
```
GET /AreaAlunno/argomenti/{corsoId}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `corsoId` | `int` | **Required**. The course id. `-1` for all courses |
**JSON Response**
```json
[
{
"data": "yyyy-MM-dd",
"argomenti": [
{
"ora": 0,
"materia": "",
"argomento": ""
},
]
},
]
```
#### Messages list
```
GET /AreaAlunno/messaggi/
```
**JSON Response**
```json
[
{
"oggetto": "",
"messaggio": "",
"mittente": "",
"letto": true,
"id": 123,
"data": "yyyy-MM-dd",
"allegati": [
{
"file": "{path}",
"nome": "{filename}",
"id": 123,
"size": 123
},
]
},
]
```
#### Read message
```
GET /AreaAlunno/leggiMessaggioFamiglia/{messageId}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `messageId` | `int` | **Required**. The message id |
**JSON Response**
```
OK
```
Probably with this endpoint the message is marked as read and the content is taken from the endpoint `/AreaAlunno/messaggi/`
#### Download attachment
```
GET /AreaAlunno/download/allegato/{attachmentId}/{messageId}/{filename}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `attachmentId` | `int` | **Required**. The attachment id |
| `messageId` | `int` | **Required**. The message id |
| `filename` | `string` | **Required**. The filename with extension |
#### Discipline notes list
```
GET /AreaAlunno/noteDisciplinari/
```
**JSON Response**
> Not available yet
#### Teacher communication list
```
GET /AreaAlunno/comunicazioni/
```
**JSON Response**
> Not available yet
#### Documents list
```
GET /AreaAlunno/documenti/{docId}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `docId` | `int` | **Required**. The document id. `-1` for all documents |
**JSON Response**
```json
[
{
"materia": "",
"nome": "",
"id": -1,
"mittente": "",
"tipo": "pagella",
"pagina": ""
}
]
```
#### Document download
```
GET /AreaAlunno/download/documenti/{doc}/scarica
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `doc` | `int` | **Required**. Base64 encoded `pagina` field from the document list |
#### Teachers' bulletin board
```
GET /AreaAlunno/bacheca/
```
**JSON Response**
```json
[
{
"descrizione": "",
"corso_id": 382482,
"docente": "",
"img_docente": "base64"
}
]
```
#### FAD (Formazione a Distanza) list
> [!WARNING]
> Work in progress
```
GET /AreaAlunno/fadPaginato/0/Tutti
```
**JSON Response**
```json
[
{
"oggetto": "",
"messaggio": "",
"mittente": "",
"letto": false,
"id": 1970859,
"data": 1726125634000,
"dataConsegna": null,
"materia": "",
"notePersonali": "",
"idNote": 10025176,
"completato": false,
"daConsegnare": false,
"allegati": [],
"consegne": []
}
]
```
#### Video conferences list
```
GET /AreaAlunno/videoconferenze/{id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `id` | `int` | **Required**. The call id. `-1` for all calls |
**JSON Response**
> Not available yet
#### Received notifications list
```
GET /AreaAlunno/notifiche?androidDevice={deviceId}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `deviceId` | `string` | **Required**. Your device id |
**JSON Response**
```json
[
{
"messaggio": "",
"data": 1726067644000
}
]
```
### Misc
#### Register firebase token (login required)
```
GET /register/regFirebaseNew/{firebaseToken}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `firebaseToken` | `string` | **Required**. Your Firebase token |
**JSON Response**
```
ok
```
## Help - feedback
You can contact me on:
Discord: https://matt05.it/discord
Telegram: https://matt05.it/telegram
Mail: mail@matteosillitti.com
## License
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
## Support me
[](https://ko-fi.com/matt05)
[](https://www.buymeacoffee.com/Matt0550)
[](https://paypal.me/sillittimatteo)
[contributors-shield]: https://img.shields.io/github/contributors/Matt0550/RegistroArchimede-API-docs.svg?style=for-the-badge
[contributors-url]: https://github.com/Matt0550/RegistroArchimede-API-docs/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Matt0550/RegistroArchimede-API-docs.svg?style=for-the-badge
[forks-url]: https://github.com/Matt0550/RegistroArchimede-API-docs/network/members
[stars-shield]: https://img.shields.io/github/stars/Matt0550/RegistroArchimede-API-docs.svg?style=for-the-badge
[stars-url]: https://github.com/Matt0550/RegistroArchimede-API-docs/stargazers
[license-shield]: https://img.shields.io/github/license/Matt0550/RegistroArchimede-API-docs.svg?style=for-the-badge
[license-url]: https://github.com/Matt0550/RegistroArchimede-API-docs/blob/master/LICENSE
[discord-shield]: https://img.shields.io/discord/828990499507404820?style=for-the-badge
[discord-url]: https://matt05.it/discord