Help > Chat Room > Général > Intégration de l'authentification unique

Intégration de l'authentification unique

Vous pouvez utiliser l'API Single Sign On (SSO) pour connecter automatiquement vos visiteurs à votre salon de chat. Cela peut être utile si vous avez une zone de connexion distincte sur votre site Web et que vous ne voulez pas que vos visiteurs se connectent deux fois.

L'API SSO vous permet d'envoyer une requête HTTP à partir de votre application pour connecter un utilisateur dans ou hors de votre salon de chat. Un jeton est retourné par l'API, qui est ensuite utilisé dans une petite balise IMG sur la page suivante pour stocker les cookies de navigateur nécessaires.

Si vous utilisez PHP, nous vous recommandons fortement d'utiliser notre Bibliothèque SSO.................. Il contient un fichier avec tout le code de bibliothèque dont vous aurez besoin et d'autres fichiers avec un exemple d'utilisation.

Si vous utilisez WordPress pour votre site Web, nous avons un Plug-in WordPress qui intègre automatiquement votre processus de connexion et d'inscription.

Veuillez suivre les instructions ci-dessous pour intégrer l'API SSO à votre site Web.

Obtenir votre clé API

La clé API est passée en tant que paramètre dans vos appels API pour vérifier que vous êtes un utilisateur autorisé de l'API du salon de discussion. Votre clé API est comme un mot de passe pour votre compte et doit être gardée privée et sécurisée.

Vous pouvez obtenir votre boîte à outils Web chat API Key en suivant les instructions ci-dessous :

  1. Connectez-vous à votre compte de Website Toolbox.
  2. Cliquez sur le lien Paramètres.
  3. Copiez la clé d'API mentionnée en regard de l'option de clé d'API.

Effectuer la demande de génération d'un jeton d'accès

Dans le script de connexion de votre site Web, effectuez une requête HTTP à l'URL de connexion de l'API SSO :

http://CLIENT.discussionchatroom.com/sso/token/generate?apikey=APIKEY&username=USERNAME&email=EMAIL&avatarUrl=AVATARURL&password=PASSWORD

Remplacez APIKEY par la clé d'API secrète.

Remplacez USERNAME par le nom d'utilisateur de l'utilisateur à connecter.

Remplacez EMAIL par l'ID d'e-mail de l'utilisateur à connecter.

Remplacez AVATARURL par l'URL de l'image de profil de l'utilisateur. Cette option est facultative. Sinon, l'utilisateur peut toujours définir son avatar dans le salon de chat lui-même.

Remplacez PASSWORD par le mot de passe non ecrypté de l'utilisateur à connecter.

Le nom d'utilisateur et le mot de passe sont des paramètres facultatifs qui ne seront utilisés que si le compte doit être créé car il n'existe pas déjà. Si le compte est créé sans mot de passe, l'utilisateur ne sera pas en mesure de se connecter directement à la salle de chat, à moins qu'il ne réinitialise son mot de passe sur la page de connexion. La connexion SSO fonctionnerait sans problème, même si le compte de l'utilisateur n'avait pas de mot de passe.

Analyser la réponse pour récupérer le jeton d'accès

Analyser la réponse JSON de la demande envoyée à générer un jeton d'accès pour récupérer le jeton d'authentification, c'est-à-dire “access_token”. La réponse de JSON ressemblera à ceci :

{
  "success" : true,
  "message" : "This is success or failure message.",
  "access_token" : "88SngRlfrqL"
}

succès - Il correspond à l'état de la demande. Il est vrai, si le jeton d'authentification est généré avec succès. Il est faux dans le cas contraire.

message - Il s'agit d'un message partagé dans la réponse. Il est plus utile pour la réponse aux erreurs.

access_token - Il s'agit du jeton d'accès généré pour l'utilisateur après une authentification réussie. Ce jeton sera expiré dans 60 minutes pour assurer la sécurité.

Demande d'ouverture de session dans la salle de chat

Sur votre site Web, ajoutez la balise HTML IMG suivante à votre page de destination “Connexion réussie” :

<img border="0" width="1" height="1" alt="" src= "//CLIENT.discussionchatroom.com/sso/token/login?access_token=ACCESS_TOKEN&rememberMe=REMEMBERME" >

Remplacez ACCESS_TOKEN par access_token, récupéré à l'étape Analyser la réponse pour récupérer le jeton d'accès>..

Remplacez REMEMBERME par la valeur 0 ou 1. Pour que le navigateur se souvienne des informations de connexion de l'utilisateur même après la fermeture du navigateur, remplacez REMEMBERME par 1, sinon remplacez-le par 0 pour effacer les informations de connexion une fois le navigateur fermé.

La fenêtre du navigateur qui charge la balise IMG sera connectée à la salle de chat en tant qu'utilisateur avec le nom d'utilisateur fourni lors de la demande à générer un jeton d'accès..................

Le navigateur Safari est livré avec une politique de cookie conservatrice qui limite l'écriture des cookies aux seules pages choisies (“naviguées vers”) par l'utilisateur. Cela empêche le cookie de connexion du forum d'être défini sur la page de destination “Connexion réussie”. Par conséquent, la seule façon de faire fonctionner Single Sign On sur le navigateur Safari est également de passer le jeton d'authentification dans le lien de votre chat sur votre site Web. Par exemple :

<a href="http://CLIENT.discussionchatroom.com/?access_token=ACCESS_TOKEN&rememberMe=REMEMBERME">Chat Room</a>

Se déconnecter de la salle de chat

Dans le cas où l'utilisateur souhaite se déconnecter du salon de discussion ou lorsque l'utilisateur se déconnecte du site Web, ajoutez la balise HTML IMG suivante à votre page de destination “Déconnexion réussie” :

<img border="0" width="1" height="1" alt="" src="//CLIENT.discussionchatroom.com/sso/token/logout?access_token=ACCESS_TOKEN" >

Remplacez ACCESS_TOKEN par access_token, récupéré à l'étape Analyser la réponse pour récupérer le jeton d'accès..................

Si vous n'avez pas le jeton d'authentification qui a été retourné lors de la connexion, il peut être récupéré ou régénéré (si expiré) en faisant la demande à générer un jeton d'accès API.

Paramètres de l'URL

Vous pouvez définir les URL de votre site Web en suivant les instructions ci-dessous :

  1. Connectez-vous à votre compte de Website Toolbox.
  2. Cliquez sur le lien Paramètres.
  3. Dans la section “Ouverture de session unique”, indiquez les URL de votre site Web pour les pages suivantes :
    • Page de connexion : indiquez l'adresse de la page de connexion de votre site Web pour vous assurer que toutes les connexions au salon de discussion se déroulent à l'aide du formulaire de connexion de votre site Web.
    • Page de déconnexion : indiquez l'adresse de la page de déconnexion de votre site Web pour vous assurer que les utilisateurs sont affichés sur la page de déconnexion de votre site Web une fois qu'ils ont été déconnectés du salon de discussion.
    • Page d'inscription : indiquez l'adresse de la page d'inscription de votre site Web pour vous assurer que les utilisateurs sont affichés sur la page d'inscription de votre site Web en cliquant sur le lien “Créer un compte” sur la page de connexion au salon de discussion.

Enregistrez un utilisateur dans la salle de chat

Pour enregistrer un utilisateur dans le salon de discussion, faites une demande HTTP à l'URL d'inscription de l'utilisateur de l'API SSO :

http://CLIENT.discussionchatroom.com/sso/user/register?apikey=APIKEY&username=USERNAME&email=EMAIL&password=PASSWORD&avatarUrl=AVATARURL

Remplacez APIKEY par la clé d'API secrète.

Remplacez USERNAME par le nom d'utilisateur de l'utilisateur à enregistrer.

Remplacez EMAIL par l'ID d'e-mail de l'utilisateur à enregistrer.

Remplacez PASSWORD par le mot de passe non ecrypté de l'utilisateur à enregistrer. Il s'agit d'un paramètre facultatif. Dans les cas où un compte est créé sans mot de passe, l'utilisateur ne sera pas en mesure de se connecter directement à la salle de chat, à moins qu'il ne réinitialise son mot de passe sur la page de connexion. La connexion SSO fonctionnerait sans problème, même si le compte de l'utilisateur n'avait pas de mot de passe.

Remplacez AVATARURL par pour être inscrit utilisateur ? s URL de l'image de profil. Cette option est facultative.

L'envoi d'une demande d'inscription est facultatif car les comptes seront créés automatiquement s'ils n'existent pas déjà au cours d'une connexion unique à la demande de connexion..................

La réponse JSON renvoie également un jeton d'accès qui peut être utilisé pour connecter l'utilisateur. Suivez les étapes de la section Analyser la réponse pour récupérer le jeton d'accès et Demande d'ouverture de session dans la salle de chat pour vous connecter à l'utilisateur nouvellement enregistré.

Supprimer un utilisateur

Pour supprimer des utilisateurs de la salle de clavardage, effectuez une requête HTTP à l'URL de suppression d'utilisateur de l'API SSO :

http://CLIENT.discussionchatroom.com/sso/user/delete?apikey=APIKEY&emails=EMAILS

Remplacez APIKEY par la clé d'API secrète.

Remplacez EMAILS par les adresses e-mail des utilisateurs à supprimer. Il peut contenir une seule adresse e-mail ou plusieurs adresses e-mail séparées par des virgules.

Modifier les détails de l'utilisateur

Pour modifier les détails de l'utilisateur de la salle de chat, effectuez une requête HTTP à l'URL de l'utilisateur de modification de l'API SSO :

http://CLIENT.discussionchatroom.com/sso/user/edit?apikey=APIKEY&user=USER&username=NEWUSERNAME&email=NEWEMAIL&password=NEWPASSWORD&avatarUrl=NEWAVATARURL

Remplacez APIKEY par la clé d'API secrète.

Remplacez UTILISATEUR par l'adresse e-mail actuelle de l'utilisateur.

Remplacez NEWUSERNAME par le nouveau nom d'utilisateur qui doit être défini.

Remplacez NEWEMAIL par le nouvel e-mail qui doit être défini.

Remplacez NEWPASSWORD par le nouveau mot de passe qui doit être défini.

Remplacez NEWAVATARURL par la nouvelle URL d'avatar qui doit être définie.

Les paramètres apikey et l'utilisateur sont des champs obligatoires. Les autres champs sont facultatifs. Vous ne devez pas ajouter de paramètres dans l'URL dont la valeur ne doit pas être mise à jour pour l'utilisateur. La valeur de “username” et “email” ne sera pas mise à jour si elle est vide.

Remarques importantes

  • Besoin d'aide ? Nos développeurs peuvent configurer l'intégration Single Sign On sur votre site web pour seulement 149 $.Contactez-nous
  • Pour accéder au salon de chat, il devrait y avoir un lien vers le salon de chat sur votre page, comme :

    <a href=”http://CLIENT.discussionchatroom.com/”>Launch chat room</a>

  • CLIENT doit être remplacé par votre nom d'utilisateur de la Website Toolbox.
  • Les réponses peuvent être analysées à des fins de débogage. La réponse de JSON ressemblera à celle de c'est cela..................
  • La chaîne de requête doit être encodée par URL.


If you still need help, please contact us.