Le api sono disponibili per ricevere, in uno specificato formato, i dati del cliente.
Di seguito sono elencate le entità per le quali è disponibile una chiamata api:
| 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 |
Parametri richiesti
La richiesta deve essere eseguita tramite un token di accesso valido. Il token di accesso dovrà essere inviato (in GET o POST) con l'indice "accessToken" ed ha sempre 40 caratteri.
La richiesta deve anche specificare il formato di risposta desiderato. Il parametro deve avere indice "type" e deve essere passato in GET. Per ora è disponibile solo il formato json.
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.
Per comporre il filtro, si usa il seguente formato: {route di base}Search[{campo}]=valore.
IMPORTANTE: la route di base deve essere con la prima lettera maiuscola.
Esempi:
ListSearch[id]=6 ritorna solo la lista con id = 6
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.
Esempio:
relations[]=customer ritorna il modello cliente dell'entità ricercata
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
/list/index?accessToken=xxxxxxxxxxxxxxxxxxxxxxxxx&type=json&ListSearch%5Bid%5D=6
/list/index?accessToken=xxxxxxxxxxxxxxxxxxxxxxxxx&type=json&ListSearch%5Bid%5D=6&relations[]=customer
/list/index?accessToken=xxxxxxxxxxxxxxxxxxxxxxxxx&type=json&ListSearch%5Bid%5D=6&relations[]=customer&relations[]=contacts