Api MeetMe

Tutte le api di MeetMe sono disponibili previa autenticazione.

A tutte le richieste, viene restituito un json con due indici: "success"=true e "data" contenente i dati.

Login

Il login può essere eseguito tramite la normale procedura di login, nel caso non si abbia a disposizione un token valido, oppure si può eseguire un qualunque richiesta inserendo l'header authorization con l'indice "token". Il token si può recuperare eseguendo una procedura di login con credenziali.

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].

Nel caso di login errato viene restituito un json con indice "success" = false.

{
  "success": true,
  "data": {
    "id": 1,
    "name": "John",
    "surname": "Doe",
    "email": "user@example.org",
    "username": "marko@infordata.it",
    "token": "9xx50xx4xx0xx72xx29a89xxdcaxx9cxxdxx67xx",
	"creation_date": "2015-06-03 00:00:00",
	"update_date": "2018-04-11 17:50:24",
	"active": 1,
	"deleted": 0,
	"number": null,
	"bith_date": "0000-00-00",
	"tax_code": "",
	"pin": null,
	"hybridauth_provider_name": "",
	"hybridauth_provider_uid": "",
	"qualification": null,
	"customer_id": 19,
	"tipo": null,
	"language": "it",
	"default_event": 444,
	"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"contact_id": null,
	"url_redirect": "/dashboard",
	"logo": "ah7PAZIEVwHDr60ZeSs8Is7sV8NLPOLK.png",
	"notify": 1,
	"frequency": 24,
	"use_chat": 1,
	"auth_key": "",
	"registration_ip": "",
	"confirmed_at": null,
	"blocked_at": null,
	"hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"type": 1
  }
}

Login tramite token

Per eseguire il login tramite token basta accedere direttamente alla route interessata inserendo però l'header authorization con valore "token=xxxxxxxxxxxxxx".

Richieste GET

Di seguito sono elencate le entità per le quali è disponibile una chiamata GET:

"form_fields": {
    "lista": {
        "type": "text",
        "order": 0
     },
     "level": {
         "type": "dropdown",
         "data": {
              "Ospite": "Ospite",
              "Staff": "Staff",
              "Giornalista": "Giornalista",
              "Tecnico": "Tecnico",
              "test": "test"
          },
          "order": 4
     }
     ...
}

"Contact": {
    "id": "ID",
    "title": "Titolo",
    "name": "Nome"
    ...
},
"Participant": {
    "id": "ID",
    "contact_id": "Contatto ID",
    "event_id": "ID Evento",
    ...
}

Parametri delle richieste GET

Le richieste GET devono 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.

SOLO le azioni "index" permettono di utilizzare i filtri e le relazioni (spiegate di seguito).

Filtri per azioni index

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 per azioni index

È 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.

Parametri opzionali

Page e size

Questi due parametri sono gestiti in coppia e permetto la gestione della paginazione. Sono parametri GET e hanno rispettivamente chiavi "page" e "size".

"page" indica il numero di pagina richiesto mentre "size" il numero di elementi per pagina.

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

Richieste POST

Le richieste POST devono essere inviate con due header http:

Content-Type: application/x-www-form-urlencoded

Authorization: token=xxxxxxxxxxxxxxxxxxxxxxxxx

Di seguito sono elencate le url disponibili: