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

Mit der SSO-API können Sie aus Ihrer Anwendung heraus eine HTTP-Anfrage senden, um einen Benutzer in Ihren Chatroom ein- oder auszuloggen. Ein Token wird von der API zurückgegeben, das 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 Ihnen dringend, unsere SSO-Bibliothek. Es enthält eine Datei mit dem gesamten Bibliothekscode, den Sie benötigen, und andere Dateien mit Beispielverwendung.

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

Bitte folgen Sie den nachstehenden Anweisungen, um die SSO-API in Ihre Website zu integrieren.

• Holen Sie sich Ihren API-Schlüssel
• Stellen Sie die Anfrage, um das Zugriffstoken zu generieren
• Analysieren Sie die Antwort, um das Zugriffstoken abzurufen
• Login-Anfrage für den Chatroom
• Loggen Sie sich aus dem Chatroom aus
• URL-Einstellungen
• Registriere einen Benutzer im Chatroom
• Einen Benutzer löschen
• Benutzerdetails bearbeiten
• Wichtige Hinweise

Holen Sie sich Ihren API-Schlüssel

Der API-Schlüssel wird als Parameter in Ihren API-Aufrufen übergeben, um zu überprüfen, ob Sie ein autorisierter Benutzer der Chatroom-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 Website Toolbox Chat-Room-API-Schlüssel erhalten, indem Sie die folgenden Anweisungen befolgen:

1. Loggen Sie sich in Ihr Website Toolbox-Konto ein.
2. Klicken Sie auf den Link Einstellungen.
3. Kopieren Sie den API-Schlüssel, der neben der Option API-Schlüssel erwähnt wird.

Stellen Sie die Anfrage, um das Zugriffstoken zu generieren

Stellen Sie im Anmeldeskript für Ihre Website eine HTTP-Anfrage 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 Secret API Key.

Ersetzen Sie USERNAME durch den Benutzernamen des Benutzers, der angemeldet werden soll.

Ersetzen Sie EMAIL durch die E-Mail-ID des Benutzers, der angemeldet werden soll.

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

Ersetzen Sie PASSWORD durch das unverschlüsselte Passwort des Benutzers, der angemeldet werden soll.

Der Benutzername und das Passwort sind optionale Parameter, die nur verwendet werden, wenn das Konto erstellt werden muss, da es noch nicht existiert. Wenn das Konto ohne Passwort erstellt wird, kann sich der Benutzer nicht direkt im Chatroom anmelden, es sei denn, er setzt sein Passwort zuerst auf der Anmeldeseite zurück. Die SSO-Anmeldung würde auch ohne ein Passwort für das Benutzerkonto reibungslos funktionieren.

Analysieren Sie die Antwort, um das Zugriffstoken abzurufen

Analysieren Sie die JSON-Antwort der Anfrage, die an gesendet wurde Zugriffstoken generieren um das Authentifizierungstoken abzurufen, dh „access_token“. Die JSON-Antwort sieht ungefähr so aus:

{
 „Erfolg“: wahr,
 „message“: „Dies ist eine Erfolgs- oder Fehlschlagsmeldung. „,
 „access_token“: „88sngrlFrQL“
}

erfolgreich - Es entspricht dem Status der Anfrage. Es ist wahr, wenn das Authentifizierungstoken erfolgreich generiert wurde. Andernfalls ist es falsch.

Nachricht - Es ist eine Nachricht, die in der Antwort geteilt wurde. Es ist nützlicher für die Fehlerreaktion.

access_token — Es ist das Zugriffstoken, das für den Benutzer nach erfolgreicher Authentifizierung generiert wurde. Dieses Token läuft in 60 Minuten ab, um die Sicherheit zu gewährleisten.

Login-Anfrage für den Chatroom

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

Ersetzen Sie ACCESS_TOKEN durch das access_token, das in Schritt 1 abgerufen wurde Analysieren Sie die Antwort, um das Zugriffstoken abzurufen>..

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

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

Der Safari-Browser verfügt über eine konservative Cookie-Richtlinie, die das Schreiben von Cookies auf die vom Benutzer ausgewählten („navigierten“) Seiten beschränkt. Dadurch wird verhindert, dass das Anmelde-Cookie des Forums auf der Landingpage „Anmeldung erfolgreich“ gesetzt wird. Daher besteht die einzige Möglichkeit, Single Sign On im Safari-Browser zum Laufen zu bringen, darin, auch das Authentifizierungstoken im Link Ihres Chatrooms auf Ihrer Website zu übergeben. Zum Beispiel:

Loggen Sie sich aus dem Chatroom aus

Falls sich der Benutzer vom Chatroom abmelden möchte oder wenn sich der Benutzer von der Website abmeldet, fügen Sie Ihrer Landingpage „Abmelden erfolgreich“ das folgende HTML-IMG-Tag hinzu:

Ersetzen Sie ACCESS_TOKEN durch das access_token, das in Schritt 1 abgerufen wurde Analysieren Sie die Antwort, um das Zugriffstoken abzurufen.

Wenn Sie das Authentifizierungstoken, das bei der Anmeldung zurückgegeben wurde, nicht haben, können Sie es abrufen oder neu generieren (falls abgelaufen), indem Sie die Anfrage an stellen Zugriffstoken generieren API.

URL-Einstellungen

Du kannst die URLs deiner Website einrichten, indem du die folgenden Anweisungen befolgst:

1. Loggen Sie sich in Ihr Website Toolbox-Konto ein.
2. Klicken Sie auf den Link Einstellungen.
3. Geben Sie im Abschnitt „Single Sign On“ Ihre Website-URLs für die folgenden 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 Benutzern die Abmeldeseite Ihrer Website angezeigt wird, sobald sie aus dem Chatroom abgemeldet wurden.
• Anmeldeseite: Geben Sie die Adresse der Anmeldeseite Ihrer Website an, um sicherzustellen, dass Benutzern die Anmeldeseite Ihrer Website angezeigt wird, wenn sie auf der Anmeldeseite des Chatrooms auf den Link „Konto erstellen“ klicken.

Registriere einen Benutzer im Chatroom

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

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

Ersetzen Sie APIKEY durch den Secret API Key.

Ersetzen Sie USERNAME durch den Benutzernamen des zu registrierenden Benutzers.

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

Ersetzen Sie PASSWORD durch das unverschlüsselte Passwort des zu registrierenden Benutzers. Dies ist ein optionaler Parameter. In Fällen, in denen ein Konto ohne Passwort erstellt wird, kann sich der Benutzer nicht direkt im Chatroom anmelden, es sei denn, er setzt sein Passwort zuerst auf der Anmeldeseite zurück. Die SSO-Anmeldung würde auch ohne ein Passwort für das Benutzerkonto reibungslos funktionieren.

AVATARURL durch „Um registrierter Benutzer zu sein“ ersetzen? s Profil Bild-URL. Dies ist optional.

Das Senden einer Registrierungsanfrage ist optional, da Konten automatisch erstellt werden, sofern sie nicht bereits während eines Single-Sign-On-Login-Anfrage.

Die JSON-Antwort gibt auch ein Zugriffstoken zurück, mit dem der Benutzer angemeldet werden kann. Folgen Sie den Schritten in Analysieren Sie die Antwort auf Retrieve Access Wertmarke und Login-Anfrage zum Chat Zimmer um den neu registrierten Benutzer einzuloggen.

Einen Benutzer löschen

Um Benutzer aus dem Chatroom zu löschen, senden Sie eine HTTP-Anfrage an die SSO-API-URL zum Löschen von Benutzern:

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

Ersetzen Sie APIKEY durch den Secret API Key.

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

Benutzerdetails bearbeiten

Um die Details des Chatroom-Benutzers zu bearbeiten, stellen Sie eine HTTP-Anfrage an die SSO-API zur Bearbeitung der Benutzer-URL:

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

Ersetzen Sie APIKEY durch den Secret API Key.

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

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

Ersetzen Sie NEWEMAIL durch die neue E-Mail, die gesetzt 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 der URL keine Parameter hinzufügen, deren Wert für den Benutzer nicht aktualisiert werden soll. Der Wert für „username“ und „email“ wird nicht aktualisiert, wenn er leer ist.

Wichtige Hinweise

• Brauchen Sie Hilfe? Unsere Entwickler können die Single Sign On-Integration auf Ihrer Website einrichten.Kontaktiere uns
• Um auf den Chatroom zuzugreifen, sollte sich auf Ihrer Seite ein Chatroom-Link wie folgt befinden:

  Chatraum starten

• CLIENT sollte durch Ihren Website Toolbox-Chatroom-Benutzernamen ersetzt werden.
• Antworten können zu Debugging-Zwecken analysiert werden. Die JSON-Antwort sieht ähnlich aus wie diese.
• Die Abfragezeichenfolge muss URL-kodiert sein.