...
Il token ha sempre una lunghezza di 40 caratteri.
Login tramite credenziali
Il login viene eseguito tramite post alla url "user/login-api" e con i parametri LoginForm[email] e LoginForm[password].
...
Se il login va a buon fine, viene restituito un json con due indici: "success"=true e "data" contenente i dati dell'utente, tra cui il token.
Login tramite token
Per eseguire il login tramite token basta accedere direttamente alla route interessata inserendo però l'header authorization con valore "token=xxxxxxxxxxxxxx".
...
Di seguito sono elencate le entità per le quali è disponibile una chiamata getGET:
| Entità | Route di base | Azioni |
|---|---|---|
| Badge | badge | index |
| Contatti | contact | index |
| Eventi | event | index |
| Liste | list | index |
| Luoghi | hall | index |
| Mailing | mailing | index |
| Partecipanti | participant | index |
| Postazioni | location | index |
| Timbratori | timestamper | index |
Filtri
Le azioni "index" permettono anche di effettuare una ricerca impostando determinati filtri. Il filtro è un parametro GET che specifica il campo su cui applicare il filtro e il suo valore.
...
ContactSearch[name]=paolo&ContactSearch[surname]=rossi ritorna solo i contatti con nome "paolo" e cognome "rossi".
Relazioni
È possibile specificare le relazioni da ottenere insieme al modello richiesto. Il parametro deve avere indice "relations" e deve essere passato in GET.
...
relations[]=customer&relations[]=contacts ritorna il modello cliente e i modelli contatti dell'entità ricercata.
Esempi completi di richieste
/list/index?accessToken=xxxxxxxxxxxxxxxxxxxxxxxxx&type=json
...