Puoi utilizzare l'API Single Sign On (SSO) per registrare automaticamente i tuoi visitatori nella tua chat room. Questo può essere utile se hai un'area di accesso separata sul tuo sito web e non vuoi che i tuoi visitatori accedano due volte.
L'API SSO consente di inviare una richiesta HTTP dall'interno dell'applicazione per far accedere o uscire un utente dalla chat room. L'API restituisce un token, che viene poi utilizzato in un piccolo tag IMG nella pagina successiva per memorizzare i cookie del browser necessari.
Se utilizzi PHP, ti consigliamo vivamente di utilizzare il nostro Libreria SSO. Contiene un file con tutto il codice della libreria di cui avrai bisogno e altri file con un esempio di utilizzo.
Se stai usando WordPress per il tuo sito web, abbiamo un Plugin per WordPress che integra automaticamente il processo di accesso e registrazione.
Segui le istruzioni riportate di seguito per integrare l'API SSO nel tuo sito web.
- Ottieni la tua chiave API
- Effettua la richiesta di generazione del token di accesso
- Analizza la risposta per recuperare il token di accesso
- Richiesta di accesso alla chat room
- Esci dalla chat room
- Impostazioni URL
- Registrazione di un utente nella chat room
- Eliminare un utente
- Modifica dettagli utente
- Note importanti
Ottieni la tua chiave API
La chiave API viene passata come parametro nelle chiamate API per verificare che tu sia un utente autorizzato dell'API della chat room. La tua chiave API è come una password per il tuo account e deve essere mantenuta privata e sicura.
Puoi ottenere la chiave API della chat room di Website Toolbox seguendo le istruzioni seguenti:
- Accedi al tuo account Website Toolbox.
- Fai clic sul link Impostazioni.
- Copia la chiave API menzionata accanto all'opzione Chiave API.
Effettua la richiesta di generazione del token di accesso
Nello script di accesso per il tuo sito web, invia una richiesta HTTP all'URL di accesso dell'API SSO:
http://CLIENT.discussionchatroom.com/sso/token/generate?apikey=APIKEY&username=USERNAME&email=EMAIL&avatarUrl=AVATARURL&password=PASSWORD
Sostituisci APIKEY con la chiave API segreta.
Sostituisci USERNAME con il nome utente dell'utente da accedere.
Sostituisci EMAIL con l'ID e-mail dell'utente da accedere.
Sostituisci AVATARURL con l'URL dell'immagine del profilo dell'utente. Questa opzione è facoltativa. Altrimenti, l'utente può sempre impostare il proprio avatar nella chat room stessa.
Sostituisci PASSWORD con la password non crittografata dell'utente da accedere.
Il nome utente e la password sono parametri opzionali che verranno utilizzati solo se è necessario creare l'account perché non esiste già. Se l'account viene creato senza password, l'utente non sarà in grado di accedere direttamente alla chat room a meno che non reimposti prima la password nella pagina di accesso. L'accesso SSO funzionerebbe senza problemi anche senza che l'account dell'utente abbia una password.
Analizza la risposta per recuperare il token di accesso
Analizza la risposta JSON della richiesta inviata a generare token di accesso per recuperare il token di autenticazione, ad esempio «access_token». La risposta JSON sarà simile a questa:
{
«successo»: vero,
«message»: «Questo è un messaggio di successo o fallimento. «,
«access_token»: «88SNgrLFrQL»
}
successo - Corrisponde allo stato della richiesta. È vero se il token di autenticazione viene generato correttamente. Altrimenti è falso.
messaggio: è un messaggio condiviso nella risposta. È più utile per la risposta agli errori.
access_token - È il token di accesso generato per l'utente dopo l'autenticazione riuscita. Questo token scadrà tra 60 minuti per garantire la sicurezza.
Richiesta di accesso alla chat room
Sul tuo sito web, aggiungi il seguente tag HTML IMG alla tua pagina di destinazione «accesso riuscito»:
Sostituisci ACCESS_TOKEN con l'access_token, recuperato nel passaggio Analizza la risposta per recuperare il token di accesso>..
Sostituisci REMEMBERME con il valore 0 o 1. Per fare in modo che il browser ricordi le informazioni di accesso dell'utente anche dopo la chiusura del browser, sostituisci REMEMBERME con 1, altrimenti sostituiscilo con 0 per cancellare le informazioni di accesso una volta chiuso il browser.
La finestra del browser che carica il tag IMG verrà registrata nella chat room come utente con il nome utente fornito durante la richiesta a generare token di accesso.
Il browser Safari viene fornito con una politica conservativa sui cookie che limita la scrittura dei cookie solo alle pagine scelte («visitate») dall'utente. Ciò impedisce che il cookie di accesso del forum venga impostato nella pagina di destinazione «accesso riuscito». Pertanto, l'unico modo per far funzionare il Single Sign On sul browser Safari è passare anche il token di autenticazione nel link della chat room sul tuo sito web. Ad esempio:
Esci dalla chat room
Nel caso in cui l'utente desideri disconnettersi dalla chat room o quando si disconnette dal sito Web, aggiungi il seguente tag HTML IMG alla tua pagina di destinazione «disconnessione riuscita»:
Sostituisci ACCESS_TOKEN con l'access_token, recuperato nel passaggio Analizza la risposta per recuperare il token di accesso.
Se non si dispone del token di autenticazione restituito durante l'accesso, è possibile recuperarlo o rigenerarlo (se scaduto) effettuando la richiesta a generare token di accesso API.
Impostazioni URL
Puoi impostare gli URL del tuo sito web seguendo le istruzioni riportate di seguito:
- Accedi al tuo account Website Toolbox.
- Fai clic sul link Impostazioni.
- Nella sezione «Single Sign-On», specifica gli URL del tuo sito web per le seguenti pagine:
- Pagina di accesso: specifica l'indirizzo della pagina di accesso del tuo sito web per assicurarti che tutti gli accessi alle chat room avvengano utilizzando il modulo di accesso del tuo sito web.
- Pagina di disconnessione: specifica l'indirizzo della pagina di disconnessione del tuo sito Web per assicurarti che agli utenti venga mostrata la pagina di disconnessione del tuo sito Web una volta che sono stati disconnessi dalla chat room.
- Pagina di registrazione: specifica l'indirizzo della pagina di registrazione del tuo sito web per assicurarti che agli utenti venga mostrata la pagina di registrazione del tuo sito web facendo clic sul link «Crea account» nella pagina di accesso alla chat room.
Registrazione di un utente nella chat room
Per registrare un utente nella chat room, invia una richiesta HTTP all'URL di registrazione utente dell'API SSO:
http://CLIENT.discussionchatroom.com/sso/user/register?apikey=APIKEY&username=USERNAME&email=EMAIL&password=PASSWORD&avatarUrl=AVATARURL
Sostituisci APIKEY con la chiave API segreta.
Sostituisci USERNAME con il nome utente dell'utente da registrare.
Sostituisci EMAIL con l'ID e-mail dell'utente da registrare.
Sostituisci PASSWORD con la password non crittografata dell'utente da registrare. Si tratta di un parametro opzionale. Nei casi in cui viene creato un account senza password, l'utente non sarà in grado di accedere direttamente alla chat room a meno che non reimposti prima la password nella pagina di accesso. L'accesso SSO funzionerebbe senza problemi anche senza che l'account dell'utente abbia una password.
Sostituire AVATARURL con essere un utente registrato? profilo s URL dell'immagine. Questa opzione è facoltativa.
L'invio di una richiesta di iscrizione è facoltativo poiché gli account verranno creati automaticamente se non esistono già durante un firma singola su richiesta di accesso.
La risposta JSON restituirà anche un token di accesso che può essere utilizzato per accedere l'utente. Segui i passaggi in Analizza la risposta per recuperare l'accesso Token e Richiesta di accesso alla chat Camera per accedere al nuovo utente registrato.
Eliminare un utente
Per eliminare utenti dalla chat room, invia una richiesta HTTP all'URL di eliminazione degli utenti dell'API SSO:
http://CLIENT.discussionchatroom.com/sso/user/delete?apikey=APIKEY&emails=EMAILS
Sostituisci APIKEY con la chiave API segreta.
Sostituisci EMAIL con gli indirizzi email degli utenti da eliminare. Può contenere un singolo indirizzo e-mail o più indirizzi e-mail separati da virgole.
Modifica dettagli utente
Per modificare i dettagli dell'utente della chat room, invia una richiesta HTTP all'URL utente di modifica dell'API SSO:
http://CLIENT.discussionchatroom.com/sso/user/edit?apikey=APIKEY&user=USER&username=NEWUSERNAME&email=NEWEMAIL&password=NEWPASSWORD&avatarUrl=NEWAVATARURL
Sostituisci APIKEY con la chiave API segreta.
Sostituisci USER con l'indirizzo email corrente dell'utente.
Sostituisci NEWUSERNAME con il nuovo nome utente che deve essere impostato.
Sostituisci NEWEMAIL con la nuova email che deve essere impostata.
Sostituisci NEWPASSWORD con la nuova password che deve essere impostata.
Sostituisci NEWAVATARURL con il nuovo URL dell'avatar che deve essere impostato.
I parametri apikey e user sono campi obbligatori. Gli altri campi sono opzionali. Non è necessario aggiungere parametri nell'URL il cui valore non deve essere aggiornato per l'utente. Il valore per «nome utente» e «email» non verrà aggiornato se è vuoto.
Note importanti
- Hai bisogno di aiuto? I nostri sviluppatori possono configurare l'integrazione Single Sign On sul tuo sito web.Contattaci
- Per accedere alla chat room, dovrebbe esserci un link alla chat room sulla tua pagina come:
- Il CLIENTE deve essere sostituito dal nome utente della chat room di Website Toolbox.
- Le risposte possono essere analizzate a scopo di debug. La risposta JSON sarà simile a questo.
- La stringa di query deve essere codificata in URL.