MyWiFi

Login

API per gli sviluppatori : guida di riferimento

Indice delle API :

Lista utenti registrati/biglietti
Nuovo utente
Modifica utente
Eliminazione utente
Lista dei gruppi di utenti
Lista dei piani tariffari


Lista degli utenti registrati

Richiede la lista degli utenti del proprio account.
E' possibile, ma non obbligatorio, aggiungere all'url i parametri PageSize e PageIndex grazie ai quali è possibile paginare l'elenco dei dati ricevuti.

  • URL : https://api.mywifiservice.com/v1/RegisteredUsers
  • Metodo : GET
  • Parametri Url addizionali : pageSize (valore di default 100), PageIndex (valore di default 0)

Esempio di richiesta

GET https://api.mywifiservice.com/v1/RegisteredUsers?PageIndex=0&PageSize=20 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 753
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml...



Aggiunta di un nuovo utente

Questa funzione permette di aggiungere un nuovo utente/biglietto al proprio account. Nella richiesta sarà necessario fornire i dati dell'utente in formato Json o XML.

  • URL : https://api.mywifiservice.com/v1/registeredusers
  • Metodo : POST
  • Input richiesto : dati serializzati dell'utente in formato Json/xml. Campi obbligatori : GroupID, WeeklyRatePlanID, FirstName, LastName, Login, Password
  • Output : dati serializzati dell'utente creato

Esempio di richiesta

POST https://api.mywifiservice.com/v1/registeredusers HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN

...Dati Json/Xml dell'utente...

Risposta

HTTP/1.1 201 Created
Content-Type: application/json;charset=utf-8
Content-Length: 253
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml dell'utente creato...



Modifica dei dati di un utente

Il funzionamento di questa chiamata è simile al precedente ma permette di modificare la scheda di un utente anziché di crearla. Trattandosi di una chiamata REST, l'ID dell'utente deve essere fornito direttamente nella url.

  • URL : https://api.mywifiservice.com/v1/registeredusers/"RegisteredUserID dell'utente da modificare"
  • Metodo : PUT
  • Input richiesto : dati serializzati dell'utente in formato Json/xml. Campi obbligatori : GroupID, WeeklyRatePlanID, FirstName, LastName, Login, Password
  • Output : nessuno

Esempio di richiesta

PUT https://api.mywifiservice.com/v1/registeredusers/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 Ok



Eliminazione di un utente

Permette di eliminare un utente dal proprio elenco. Anche in questo caso l'ID dell'utente viene fornito direttamente al termine della url.

  • URL : https://api.mywifiservice.com/v1/registeredusers/"RegisteredUserID dell'utente da eliminare"
  • Metodo : DELETE

Esempio di richiesta

DELETE https://api.mywifiservice.com/v1/registeredusers/2248 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 204 No Content



Lista dei gruppi di utenti

Richiede la lista dei gruppi di utenti del proprio account.

  • URL : https://api.mywifiservice.com/v1/Groups
  • Metodo : GET

Esempio di richiesta

GET https://api.mywifiservice.com/v1/Groups HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 272
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml...



Lista dei piani tariffari

Richiede la lista dei piani tariffari del proprio account.

  • URL : https://api.mywifiservice.com/v1/WeeklyRatePlans
  • Metodo : GET

Esempio di richiesta

GET https://api.mywifiservice.com/v1/WeeklyRatePlans HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 272
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml...