Uso delle API
Per amministrare gli utenti, inviare richieste HTTP al servizio userservice.
L’indirizzo del servizio http://chatme.im/plugins/userService/userservice.
Di seguito i parametri che possono essere usati per inviare le richieste:
| Nome | Descrizione | |
|---|---|---|
| Type | Richiesto | Il servizio richiesto. Valori possibili add, delete, update, enable, disable |
| secret | Richiesto | La frase segrata del servizio, comunicata dall’amministratore. |
| username | Richiesto | L’username dell’utente da aggiungere, aggiornare, cancellare, attivare o disattivare, di solito la parte prima del simbolo @. |
| password | Richiesto per l’operazione add | La password dell’utente da aggiungere o aggiornare. |
| name | Opzionale | Il nome visualizzato dal nuovo utente o dall’utente aggiornato. |
| Opzionale | L’indirizzo e-mail del nuovo utente o dell’utente da aggiornare. | |
| groups | Opzionale | La lista dei gruppi a cui l’utente appartiene, i valore devono essere separati con una virgola. |
Esempi HTML
L’esempio seguente mostra come aggiungere gli utenti:
L’esempio seguente mostra come cancellare gli utenti:
L’esempio seguente mostra come disattivare gli utenti:
L’esempio seguente mostra come abilitare gli utenti:
L’esempio seguente mostra come aggiornare un utente:
*Quando si ivniano caratteri particolari (esempio in Cinese, Giapponese, Coreano, ecc…) è importante codificare la stringa in UTF8.
In Java questo si fa
URLEncoder.encode(username, “UTF-8″));
Se il carattere non è correttamente codificato la stringa potrebbe essere modificata dal server.
Risposte del server
Il server risponde ad ogni richiesta con una pagina XML.
Se la richiesta è correttamente inviata la pagina avrà un elemento “result” e il testo sarà “OK”.
Se la richiesta non ha avuto successo sarà ritornato un elemento “error” con il testo indicato nella tabella seguente:
| Stringa Errore | Descrizione |
|---|---|
| IllegalArgumentException | Alcuni parametri inviati nella richiesta sono errati. |
| UserNotFoundException | Nessun utente con l’user specificato è presente, per cancellare o aggiornare un utente questo deve esistere. |
| UserAlreadyExistsException | Un utente con il nome specificato esiste già. |
| RequestNotAuthorised | La frase segreta specificata non è corretta o la richiesta provviene da un IP non abilitato. |
| UserServiceDisabled | Il servizio è disattivato dall’amministratore di sistema. |
Admin Status
Aggiungi admin ai tuoi contatti chatme per chattare con noi.
Inserzioni
