Help > Chat Room > General > Integration mit Single Sign On

Integration mit Single Sign On

Sie können die Single Sign On (SSO) -API verwenden, um Ihre Besucher automatisch in Ihren Chat-Raum einzuloggen. Dies kann hilfreich sein, wenn Sie einen separaten Anmeldebereich auf Ihrer Website haben und Ihre Besucher nicht zweimal anmelden möchten.

Die SSO-API ermöglicht es Ihnen, eine HTTP-Anfrage innerhalb Ihrer Anwendung zu senden, um einen Benutzer in oder aus Ihrem Chatroom anzumelden. Ein Token wird von der API zurückgegeben, die dann in einem kleinen IMG-Tag auf der nächsten Seite verwendet wird, um die notwendigen Browser-Cookies zu speichern.

Wenn Sie PHP verwenden, empfehlen wir dringend, unsere SSO-Bibliothek. Es enthält eine Datei mit dem gesamten benötigten Bibliothekscode und andere Dateien mit Beispielverwendung.

Wenn Sie WordPress für Ihre Website verwenden, haben wir eine WordPress-Plugin , die Ihren Anmelde- und Registrierungsprozess automatisch integriert.

Bitte befolgen Sie die folgenden Anweisungen, um die SSO-API in Ihre Website zu integrieren.

API-Schlüssel abrufen

Der API-Schlüssel wird als Parameter in Ihren API-Aufrufen übergeben, um zu überprüfen, ob Sie ein autorisierter Benutzer der Chat-Raum-API sind. Ihr API-Schlüssel ist wie ein Passwort für Ihr Konto und sollte privat und sicher aufbewahrt werden.

Sie können Ihren API-Schlüssel für den Chatroom der Website Toolbox erhalten, indem Sie die folgenden Anweisungen befolgen:

  1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
  2. Klicken Sie auf den Link Einstellungen.
  3. Kopieren Sie den API-Schlüssel, der neben der API-Schlüsseloption erwähnt wird.

Anfordern des Zugriffstoken erstellen

Stellen Sie im Anmeldeskript für Ihre Website eine HTTP-Anforderung an die SSO-API-Anmelde-URL:

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

Ersetzen Sie APIKEY durch den geheimen API-Schlüssel.

Ersetzen Sie USERNAME durch den Benutzernamen des angemeldeten Benutzers.

Ersetzen Sie EMAIL durch die E-Mail-ID des angemeldeten Benutzers.

Ersetzen Sie AVATARURL durch die URL des Profilbilds des Benutzers. Dies ist optional. Andernfalls kann der Benutzer seinen Avatar immer im Chatroom selbst einstellen.

Ersetzen Sie PASSWORD durch das nicht entschlüsselte Kennwort des angemeldeten Benutzers.

Der Benutzername und das Kennwort sind optionale Parameter, die nur verwendet werden, wenn das Konto erstellt werden muss, da es noch nicht vorhanden ist. Wenn das Konto ohne Kennwort erstellt wird, kann sich der Benutzer nicht direkt im Chatroom anmelden, es sei denn, er setzt sein Kennwort zunächst auf der Anmeldeseite zurück. SSO-Anmeldung funktioniert reibungslos, auch ohne das Konto des Benutzers mit einem Kennwort.

Analysieren des Antworttoken zum Abrufen des Zugriffstokens

Analysieren Sie die JSON-Antwort der an Zugriffstoken generieren , um das Authentifizierungstoken abzurufen, d. h. “access_token”. Die JSON-Antwort sieht etwa wie folgt aus:

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

success - Es entspricht dem Status der Anforderung. Es ist wahr, wenn das Authentifizierungstoken erfolgreich generiert wird. Andernfalls ist es falsch.

message - Es handelt sich um eine Nachricht, die in der Antwort freigegeben wurde. Es ist nützlicher für die Fehlerantwort.

access_token - Es ist das Zugriffstoken, das nach erfolgreicher Authentifizierung für den Benutzer generiert wird. Dieses Token ist in 60 Minuten abgelaufen, um die Sicherheit zu gewährleisten.

Login-Anfrage für den Chat-Raum

Fügen Sie auf Ihrer Website das folgende HTML IMG-Tag zu Ihrer Zielseite “Anmeldung erfolgreich” hinzu:

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

Ersetzen Sie ACCESS_TOKEN durch das access_token, das in Schritt abgerufen wird. Analysieren der Antwort zum Abrufen des Zugriffstoken>..

Ersetzen Sie REMBERME durch den Wert 0 oder 1. Damit sich der Browser auch nach dem Schließen des Browsers an die Anmeldedaten des Benutzers erinnert, ersetzen Sie REMBERME durch 1, andernfalls ersetzen Sie es durch 0, um die Anmeldeinformationen zu löschen, sobald der Browser geschlossen ist.

Das Browserfenster, das das IMG-Tag lädt, wird als Benutzer mit dem angegebenen Benutzernamen im Chatroom angemeldet, während die Anfrage an Zugriffstoken generieren.

Der Safari-Browser wird mit einer konservativen Cookie-Richtlinie ausgeliefert, die die Schreibvorgänge von Cookies auf die vom Benutzer ausgewählten Seiten beschränkt (“navigiert zu”). Dadurch wird verhindert, dass das Anmelde-Cookie des Forums auf der Zielseite “Anmeldung erfolgreich” gesetzt wird. Daher ist die einzige Möglichkeit, Single Sign On im Safari-Browser zu aktivieren, auch das Authentifizierungstoken im Chat-Room-Link auf Ihrer Website zu übergeben. Zum Beispiel:

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

Abmelden im Chatroom

Wenn sich der Benutzer vom Chatroom abmelden möchte oder sich der Benutzer von der Website abmeldet, fügen Sie der Zielseite “Abmelden erfolgreich” das folgende HTML IMG-Tag hinzu:

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

Ersetzen Sie ACCESS_TOKEN durch das access_token, das in Schritt abgerufen wird. Analysieren des Antworttoken zum Abrufen des Zugriffstokens.

Wenn Sie nicht über das Authentifizierungstoken verfügen, das während der Anmeldung zurückgegeben wurde, kann es abgerufen oder regeneriert werden (falls abgelaufen), indem Sie die Anforderung an Zugriffstoken generieren API.

URL-Einstellungen

Sie können Ihre Website-URLs festlegen, indem Sie die folgenden Anweisungen befolgen:

  1. Melden Sie sich bei Ihrem Website Toolbox-Konto an.
  2. Klicken Sie auf den Link Einstellungen.
  3. Geben Sie unter “Single Sign On” Ihre Website-URLs für folgende Seiten an:
    • Anmeldeseite: Geben Sie die Adresse der Anmeldeseite Ihrer Website an, um sicherzustellen, dass alle Chatroom-Anmeldungen über das Anmeldeformular Ihrer Website erfolgen.
    • Abmeldeseite: Geben Sie die Adresse der Abmeldeseite Ihrer Website an, um sicherzustellen, dass den Benutzern die Abmeldeseite Ihrer Website angezeigt wird, sobald sie sich aus dem Chatraum abgemeldet haben.
    • Registrierungsseite: Geben Sie die Adresse der Registrierungsseite Ihrer Website an, um sicherzustellen, dass die Registrierungsseite Ihrer Website angezeigt wird, indem Sie auf den Link “Konto erstellen” auf der Anmeldeseite des Chatrooms klicken.

Registrieren Sie einen Benutzer im Chatraum

Um einen Benutzer im Chatroom zu registrieren, stellen Sie eine HTTP-Anfrage an die SSO API-Benutzer-Registrierungs-URL:

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

Ersetzen Sie APIKEY durch den geheimen API-Schlüssel.

Ersetzen Sie USERNAME durch den Benutzernamen des registrierten Benutzers.

Ersetzen Sie die E-Mail-Adresse durch die E-Mail-ID des registrierten Benutzers.

Ersetzen Sie PASSWORD durch das nicht entschlüsselte Kennwort des registrierten Benutzers. Dies ist ein optionaler Parameter. In Fällen, in denen ein Konto ohne Kennwort erstellt wird, kann sich der Benutzer nicht direkt im Chatroom anmelden, es sei denn, er setzt sein Kennwort zunächst auf der Anmeldeseite zurück. SSO-Anmeldung funktioniert reibungslos, auch ohne das Konto des Benutzers mit einem Kennwort.

Ersetzen Sie AVATARURL durch, um registrierter Benutzer zu sein? s Profilbild-URL. Dies ist optional.

Das Senden einer Registrierungsanfrage ist optional, da Konten automatisch erstellt werden, wenn sie nicht bereits während einer Single Sign On-Anmeldeanforderung.

Die JSON-Antwort gibt auch ein Zugriffstoken zurück, das zum Anmelden des Benutzers verwendet werden kann. Befolgen Sie die Schritte unter Analysieren des Antworttoken zum Abrufen des Zugriffstokens und Login-Anfrage für den Chat-Raum , um sich beim neu registrierten Benutzer anzumelden.

Löschen eines Benutzers

Um Benutzer aus dem Chatroom zu löschen, stellen Sie eine HTTP-Anforderung an die SSO API-Benutzer-Löschungs-URL:

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

Ersetzen Sie APIKEY durch den geheimen API-Schlüssel.

Ersetzen Sie EMAILS durch die E-Mail-Adressen der zu löschenden Benutzer. Es kann entweder eine einzelne E-Mail-Adresse oder mehrere kommagetrennte E-Mail-Adressen enthalten.

Benutzerdetails bearbeiten

Um Details des Chatroom-Benutzers zu bearbeiten, erstellen Sie eine HTTP-Anforderung an die SSO API, um die Benutzer-URL zu bearbeiten:

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

Ersetzen Sie APIKEY durch den geheimen API-Schlüssel.

Ersetzen Sie USER durch die aktuelle E-Mail-Adresse des Benutzers.

Ersetzen Sie NEWUSERNAME durch den neuen Benutzernamen, der festgelegt werden muss.

Ersetzen Sie NEWEMAIL durch die neue E-Mail, die festgelegt werden muss.

Ersetzen Sie NEWPASSWORD durch das neue Passwort, das gesetzt werden muss.

Ersetzen Sie NEWAVATARURL durch die neue Avatar-URL, die festgelegt werden muss.

Die Parameter apikey und user sind Pflichtfelder. Die anderen Felder sind optional. Sie sollten keine Parameter in der URL hinzufügen, deren Wert für den Benutzer nicht aktualisiert werden soll. Der Wert für “Benutzername” und “E-Mail” wird nicht aktualisiert, wenn er leer ist.

Wichtige Hinweise

  • Benötigen Sie Hilfe? Unsere Entwickler können Single Sign On-Integration für nur 149 $ auf Ihrer Website einrichten.Kontaktieren Sie uns
  • Um auf den Chat-Raum zuzugreifen, sollte es einen Chat-Raum-Link auf Ihrer Seite geben, wie:

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

  • Der KUNDE sollte durch Ihren Chatroom-Benutzernamen für die Website Toolbox ersetzt werden.
  • Antworten können zum Debuggen analysiert werden. Die JSON-Antwort sieht ähnlich aus wie das.
  • Die Abfragezeichenfolge muss URL-kodiert sein.


If you still need help, please contact us.