Documentaione Rotte API

Il pacchetto è interamente basato su API per il recupero delle informazioni e dei dati. Di seguito verranno elencate le rotte e la documentazione delle possibili variabili da passare.

Struttura base della risposta delle rotte

{
   success: true/false,
   message: 'messaggio di risposta',
   data: 'null o oggetto dei dati di ritorno in base alla chiamata effettuata'
}

chiave	type	note
success	boolean	sempre presente
message	string	sempre presente (o vuoto)
data	varius	dipende dalla singola richiesta

Lista delle rotte disponibili

/api/auth/login [POST]

Rotta per l'accesso

chiave	note
email	obbligatorio
password	obbligatorio

/api/auth/recover [POST]

Rotta per il recupero della password e l'invio della mail con l'url per il recupero

chiave	note
email	obbligatorio

/api/auth/recover-post [POST]

Rotta per il cambio della password dopo ave rla recuperata

chiave	note
token	obbligatorio
email	obbligatorio
password	obbligatorio
password_confirmation	obbligatorio

/api/auth/register [POST]

Rotta per la registrazione di un nuovo utente

chiave	note
username	obbligatorio
email	obbligatorio
password	obbligatorio
password_confirmation	obbligatorio
date_of_birth	obbligatorio - Formato Y-m-d

/api/auth/logout[POST]

Rotta per il logout dell'utente

/api/auth/email-verify [POST]

Rotta per la verifica dell'email (con utente loggato)

chiave	note
id	obbligatorio
hash	obbligatorio

/api/auth/email-resend [POST]

Rotta per il reinvio della mail di verifica (con utente loggato)

/api/check/{permission}/{model}/{id?} [GET]

Rotta per la verifica dei permessi dell'utente (utilizzata per l'accesso a pagine e verifica che l'utente possa effettivamente accedervi).

chiave	note
{permission}	tipologia di permesso richiesto
{model}	model di destinazione della verifica del permesso
{id?}	id dell'entità di verifica del permesso, può essere omesso e si verificherà che l'utente ha accesso alla visualizzazione della lista delle enità oppure impostato a current-user per la verifica sull'utente in sessione