diff --git a/End-point.-.md b/End-point.-.md new file mode 100644 index 0000000..fe9ca44 --- /dev/null +++ b/End-point.-.md @@ -0,0 +1,146 @@ + +# Documentazione API - AMT Genova (Versione 1) + +## Base URL +``` +/api/v1/ +``` + +--- + +## GET /fermate/:codicelinea + +Restituisce tutte le fermate per la linea specificata. + +### Esempio richiesta: +``` +GET /fermate/001-00 +``` + +### Esempio risposta: +```json +{ + "codice_linea": "001-00", + "andata": [ + { + "codice_linea": "001-00", + "direzione": "1", + "codice_fermata": "0170", + "ordine": 1 + }, + { + "codice_linea": "001-00", + "direzione": "1", + "codice_fermata": "0003", + "ordine": 2 + } + ] +} +``` + +--- + +## GET /linee + +Restituisce tutte le linee disponibili. + +### Esempio risposta: +```json +[ + { + "codice": "001-00", + "numero": "1", + "capolinea_andata": "Caricamento (Ponente)", + "capolinea_ritorno": "Via Camozzini (Voltri)", + "attiva": true, + "note": "" + }, + { + "codice": "003-00", + "numero": "3", + "capolinea_andata": "Staz. Principe", + "capolinea_ritorno": "Via Soliman (Sestri)", + "attiva": true, + "note": "" + } +] +``` + +--- + +## GET /orari/:codice_linea/:data + +Restituisce gli orari previsti per una determinata linea e giorno. + +### Esempio richiesta: +``` +GET /orari/051/2025-06-09 +``` + +### Esempio risposta: +```json +{ + "linea": "051", + "data": "2025-06-09", + "servizi": [ + { + "codice": "51", + "barrato": false, + "targa": "LINEA 51", + "descrizione": "Sestri (Via Biancheri) - Via Rollino", + "tratte": { + "andata": { + "descrizione": "Via Biancheri (Sestri) ---> Via Rollino", + "partenze": ["05:45"] + } + } + } + ] +} +``` + +--- + +## GET /passaggi/:codice_fermata + +Restituisce i prossimi transiti e i tempi di attesa alla fermata. + +### Esempio richiesta: +``` +GET /passaggi/0045 +``` + +### Esempio risposta: +```json +{ + "codice_fermata": "0045", + "timestamp": "2025-06-08T06:25:15.175Z", + "passaggi": [ + { + "linea": "001/", + "destinazione": "VOLTRI", + "orario": "08:32:52", + "attesa": "8'", + "teorico": false, + "id_corsa": "09172", + "pieno": false + }, + { + "linea": "192", + "destinazione": "VOLTRI FS", + "orario": "08:34:22", + "attesa": "9'", + "teorico": false, + "id_corsa": "07063", + "pieno": false + } + ] +} +``` + +--- + +## Limiti di utilizzo + +- **Senza token**: massimo 60 richieste al minuto. +- **Con token**: massimo 300 richieste al minuto (prioritarie).