Verwenden beschränkter Help-Center-Inhalte mit dem Web Widget (Classic)

Welchen Plan habe ich

Suite

Team, Growth, Professional, Enterprise oder Enterprise Plus

Support

Team, Professional oder Enterprise

Sie können Inhalte aus einem beschränkten Help Center (auf das nur angemeldete Benutzer zugreifen können) oder beschränkte Wissensdatenbankinhalte (aus einem öffentlichen Help Center mit Beiträgen, die auf bestimmte Benutzer beschränkt sind) in das Web Widget (Classic) einbetten.

Wenn das Web Widget (Classic) beschränkte Inhalte enthält, gilt Folgendes:

• Angemeldete Besucher Ihrer Website können die beschränkten Help-Center-Beiträge über das Web Widget (Classic) lesen. Die Kundenwebsite, in die das Web Widget eingebettet ist, ist für die Authentifizierung der E-Mail-Adresse eines Benutzers verantwortlich.
• Nicht angemeldete Besucher sehen nur die öffentlichen Beiträge. Wenn es keine öffentlichen Beiträge gibt, sind die Help-Center-Funktionen im Web Widget (Classic) nicht verfügbar.

Dieser Beitrag enthält die folgenden Themen:

• Ermitteln der Sicherheitseinstellungen für das Help Center
• Einrichten des Web Widgets (Classic), damit beschränkte Inhalte erscheinen
• Codebeispiele

Hinweis: Sie brauchen keine Single-Sign-On- (SSO-) Verbindung zwischen Ihrer Website und dem Help Center, um diese Funktionalität nutzen zu können. SSO sorgt aber für ein besseres Erlebnis für Benutzer, die im Web Widget (Classic) auf „Originalbeitrag anzeigen“ klicken. Selbst wenn SSO bereits eingerichtet ist, müssen Sie das Web Widget (Classic) entsprechend konfigurieren, damit Sie SSO nutzen können.

Weitere Informationen zum Web Widget (Classic) finden Sie unter Einbetten von Kundenserviceoptionen in Ihre Website anhand des Web Widgets (Classic).

Weitere Informationen zu beschränkten Help-Center- und Wissensdatenbankinhalten finden Sie unter Beschränken der Inhalte auf angemeldete Benutzer und Beschränken des Zugriffs auf Wissensdatenbankinhalte.

Ermitteln der Sicherheitseinstellungen für das Help Center

Im Web Widget (Classic) können mit einer der folgenden Sicherheitskonfigurationen Inhalte aus einem Help Center angezeigt werden: Je nach Art des Help Centers müssen Sie die Option „Anmeldung erforderlich“ in den Help-Center-Einstellungen aktivieren oder deaktivieren.

Art von Help Center	„Anmeldung erforderlich“ aktivieren?
Öffentliches Help Center: Alle Inhalte sind öffentlich verfügbar.	Anmeldung erforderlich nicht aktivieren.
Beschränktes Help Center: Benutzer müssen registriert sein und sich anmelden, um Inhalte sehen zu können.	Anmeldung erforderlich aktivieren.
Öffentliches Help Center mit beschränkten Inhalten: Manche Beiträge sind nur für bestimmte Benutzer sichtbar, andere für alle Besucher.	Anmeldung erforderlich nicht aktivieren. Unbeschränkte Beiträge im Help Center sind ohne Anmeldung für alle Besucher sichtbar, beschränkte Beiträge hingegen nur für angemeldete Benutzer mit den entsprechenden Berechtigungen.

So überprüfen Sie die Sicherheitseinstellungen für das Help Center

1. Klicken Sie in der Seitenleiste von Wissensadministrator auf das Symbol Einstellungen ().
2. Aktivieren oder deaktivieren Sie je nach Art des Help Centers im Abschnitt Sicherheit die Option Anmeldung erforderlich.

   

3. Wenn Sie ein beschränktes Help Center oder ein öffentliches Help Center mit beschränkten Inhalten haben, fahren Sie wie unter Einrichten des Web Widgets (Classic), damit beschränkte Inhalte erscheinen beschrieben fort.

Einrichten des Web Widgets (Classic), damit beschränkte Inhalte erscheinen

Wenn Sie ein beschränktes Help Center oder ein öffentliches Help Center mit beschränkten Inhalten haben, enthält es beschränkte Beiträge (siehe Ermitteln der Sicherheitseinstellungen für das Help Center). Wenn beschränkte Inhalte im Web Widget (Classic) angezeigt werden sollen, müssen Sie die Einstellungen für das Web Widget (Classic) entsprechend konfigurieren und zusätzliche Snippets in den Website-Code einfügen.

Wenn Sie ein öffentliches Help Center haben, sind diese Schritte nicht erforderlich.

Als Erstes müssen Sie die Einstellungen für das Web Widget (Classic) überprüfen und ein Shared Secret generieren.

So überprüfen Sie die Widget-Einstellungen und generieren ein Shared Secret

1. Klicken Sie in der Seitenleiste des Admin Centers auf das Symbol Kanäle und dann auf Classic > Web Widget.
2. Klicken Sie auf die Registerkarte Basisinformationen.
3. Stellen Sie sicher, dass das Kontrollkästchen „Help Center“ ausgewählt ist.

   Sofern noch nicht geschehen, aktivieren oder deaktivieren Sie je nach Art des Help Centers die Option Anmeldung erforderlich (siehe Ermitteln der Sicherheitseinstellungen für das Help Center).

4. Klicken Sie auf die Registerkarte Sicherheit.
5. Geben Sie im Feld Zulassungsliste die Subdomänen ein, die das Web Widget (Classic) enthalten. Dadurch können authentifizierte Benutzer beschränkte Help-Center-Inhalte im Widget anzeigen.

   Zu Ihrer Sicherheit empfehlen wir, Subdomänen zur Zulassungsliste hinzuzufügen. Sie können dieses Feld leer lassen, wenn Sie aus irgendeinem Grund vermuten, dass die Beschränkung des Zugriffs auf bestimmte Domänen nicht funktioniert. Verwenden Sie Leerzeichen, um Subdomänen voneinander zu trennen.

6. Aktivieren Sie die Option Agenten Zugriff auf beschränkte Help-Center-Inhalte gewähren, damit Agenten und Administratoren beschränkte Help-Center-Inhalte im Web Widget (Classic) anzeigen können.

   Wenn Sie ein beschränktes Help Center haben und der Agentenzugriff nicht aktiviert ist, sehen Agenten und Administratoren auch keine Help-Center-Funktionen im Web Widget (Classic). Wenn Sie beschränkte Beiträge haben und der Agentenzugriff nicht aktiviert ist, sehen Agenten nur die öffentlichen Inhalte.

7. Konfigurieren Sie das Shared Secret:
   • Erstellen Sie ein Shared Secret, indem Sie auf die Schaltfläche Generieren klicken:

     Beim Shared Secret handelt es sich um eine Sicherheitseinstellung. Das Secret muss generiert, kopiert und in der gleichen Sitzung in eine Nachricht an das Engineering-Team oder direkt in den Code eingefügt werden. Es darf nicht in den Browser eingegeben werden.

     

     Hinweis: Es ist wichtig, dass die Sicherheit des Shared Secret jederzeit gewährleistet ist. Deshalb erscheint es nur einmal in ganzer Länge. Wenn Sie keinen Zugriff auf das Shared Secret haben und die komplette Zeichenfolge brauchen, um ein Token zu erstellen, können Sie auf Zurücksetzen klicken, um das Secret zurückzusetzen.
   • Wenn der Verdacht besteht, dass das Shared Secret kompromittiert ist, können Sie nach dem Zurücksetzen des Shared Secret alle existierenden Token widerrufen. Dadurch werden die Zugriffsberechtigungen aller Benutzer ungültig, die sich zuvor authentifiziert hatten, und der Zugriff auf beschränkte Inhalte ist erst nach Ausgabe eines neuen gültigen Tokens wieder möglich.

Nachdem Sie das Shared Secret generiert haben, erstellen Sie ein JWT-Token (weitere Informationen zu JWT), das Sie dann zum Snippet des Web Widgets (Classic) hinzufügen.

So erstellen Sie ein JWT-Token und fügen den Code zum Snippet des Web Widgets (Classic) hinzu

1. Erstellen Sie eine serverseitige Payload für das JWT-Token. Sie muss folgende Informationen enthalten:
   • name: Name des Benutzers.
   • email: E-Mail-Adresse des Benutzers.
   • iat: ganzzahliger Wert für den aktuellen Zeitstempel in Sekunden. Manche Funktionen in bestimmten Sprachen, wie z. B. Date.now() in JavaScript, geben Millisekunden zurück; vergessen Sie nicht, Millisekunden in Sekunden umzurechnen.

     Bei der Web-Widget-Authentifizierung lässt der Wert iat eine Uhrzeittoleranz von bis zu zwei Minuten zu.

   • jti: eindeutige ID für dieses Token. Muss sich von der ID aller bereits übertragenen JWT-Token unterscheiden. Ideal ist eine nach dem Zufallsprinzip gewählte 64-Bit-Zahl.
2. Geben Sie HS256 als JWT-Algorithmus im Header der JWT-Payload an:

   {
     "typ":"JWT",
     "alg":"HS256"
   }

   HS256 steht für HMAC SHA 256, einen 256-Bit-Verschlüsselungsalgorithmus der U.S. National Security Agency.

   Hinweis: Die JWT-Algorithmen RS256 und ES256 JWT werden von Zendesk nicht unterstützt.
3. In den Codebeispielen unten finden Sie Vorlagen für die gängigsten Sprachen.
4. Fügen Sie eine Funktion hinzu, die Ihr JWT-Token von Ihrem Server abruft und einen Rückruf mit dem JWT-Wert durchführt. Ersetzen Sie „YOUR_JWT_TOKEN“ durch das von Ihnen erstellte Token. Achten Sie darauf, dass dieser Code vor dem Snippet des Web Widgets (Classic) erscheint:

   
   <script type="text/javascript">
   window.zESettings = {
       webWidget: {
         authenticate: {
           jwtFn: function(callback) {
             callback('YOUR_JWT_TOKEN');
               }
           }
       }
   };
   </script>

   Token sind zwei Stunden lang gültig. Sie können ein Token früher aus dem lokalen Speicher entfernen, indem Sie den folgenden API-Anruf verwenden, wenn ein Benutzer sich abmeldet:

   <script type="text/javascript">
   zE(function() {
    zE.logout();
   });
   </script>

Codebeispiele

Das Token muss beim Laden der Webseite auf Serverseite dynamisch generiert werden. Machen Sie unten die Vorlage für die verwendete Sprache ausfindig. Passen Sie die Vorlage entsprechend an, indem Sie #{Details} durch Ihre eigenen Informationen ersetzen.

Wenn Ihnen die folgenden Vorlagen nicht weiterhelfen, werfen Sie einen Blick auf die JWT-Bibliotheken.

• Ruby
• NodeJS
• Python
• PHP
• Elixir

Ruby

Installieren Sie zuerst ruby-jwt.

Wenn Sie Rubygems verwenden:

gem install jwt

Wenn Sie Bundler verwenden, fügen Sie Folgendes zu Ihrer gem-Datei hinzu:

gem 'jwt'

Generieren Sie dann ein Token anhand des Shared Secret:

require 'jwt'
payload = {
  :name => "#{customerName}",
  :email => "#{customerEmail}",
  :iat => timestamp,
  :jti => "#{uniqueId}"
}
token = JWT.encode payload, "#{yourSecret}"

NodeJS

Installieren Sie jsonwebtoken:

npm install jsonwebtoken --save-dev

Generieren Sie dann ein Token anhand des Shared Secret:

var jwt = require('jsonwebtoken'); 
var payload = {
  name: '#{customerName}',
  email: '#{customerEmail}',
  iat: #{timestamp}, 
  jti: '#{uniqueId}'
};
var token = jwt.sign(payload, '#{yourSecret}');

Python

Installieren Sie python-jose:

pip install python-jose

Generieren Sie dann ein Token anhand des Shared Secret:

from jose import jwt
var payload = {
  'name': '#{customerName}',
  'email': '#{customerEmail}',
  'iat': #{timestamp}, 
  'jti': '#{uniqueId}'
}
token = jwt.encode(payload, '#{yourSecret}'

PHP

Laden Sie PHP-JWT herunter:

composer require firebase/php-jwt

Generieren Sie dann ein Token anhand des Shared Secret:

use \Firebase\JWT\JWT;
$payload = {
  'name' => '#{customerName}' ,
  'email' => '#{customerEmail}',
  'iat' => #{timestamp},
  'jti' => '#{uniqueId}'
};
$token = JWT::encode($payload, '#{yourSecret}');

Elixir

Fügen Sie „json_web_token_ex“ zur Datei „mix.exs“ hinzu:

defp deps do
  [{:json_web_token, "~> 0.2"}]
end

Generieren Sie dann ein Token anhand des Shared Secret:

data = %{
  name: "#{customerName}",
  email: "#{customerEmail}",
  iat: "#{timestamp}",
  jti: "#{uniqueId}"
}
options = %{ key: "#{yourSecret}" }
jwt = JsonWebToken.sign data, options