🕸️Website Integration
Die Integration Ihres Bots in Ihre Website verbessert das Nutzerengagement und bietet direkte Unterstützung auf Ihrer Plattform. Dieser Prozess ist unkompliziert und beinhaltet das Einbetten eines kleinen Code-Snippets.
Integration der Webkomponente
Um die Chat-Element-Komponente in Ihre Website einzubinden, folgen Sie diesen Schritten:
Teilen Sie uns den Ursprung (Origin) der Seite mit, in die Sie integrieren möchten
Fügen Sie den folgenden Script-Tag in Ihre HTML-Datei ein:
Fügen Sie den
<blockbrain-main>
-Tag dort ein, wo Sie die Chat-Komponente platzieren möchten:
Ersetzen Sie
clientId
undsecretKey
durch Ihre tatsächliche Client-ID und Ihren geheimen Schlüssel, dieuid
durch die Kontonummer / Maschinen-UID unduserUid
durch eine eindeutige Benutzer-ID, falls Sie eine haben, die Sie senden können - andernfalls entfernen Sie sie einfach.
Private Mode Integration (Authentifizierte Nutzung)
Für eine sichere und authentifizierte Nutzung konfigurieren Sie die Webkomponente im privaten Modus mit dem issuer
-Attribut. Erforderliche Attribute:
orgId
: Für Ihre Instanz bereitgestellte Organisations-ID.issuer
: URL Ihrer Blockbrain-Domain.uid
: Eindeutiger Identifikator für die Bot-Instanz oder Anwendung.userUid
: Eindeutiger Identifikator für den Benutzer (optional).
Beispiel:
Public Mode Integration (Nicht-authentifizierte Nutzung)
Für Szenarien, in denen keine Authentifizierung erforderlich ist, konfigurieren Sie die Webkomponente im öffentlichen Modus mit dem clientSecret
-Attribut. Erforderliche Attribute:
orgId
: Für Ihre Instanz bereitgestellte Organisations-ID.clientSecret
: Ein Client-Geheimnis zur Aktivierung des öffentlichen Modus.uid
: Eindeutiger Identifikator für die Bot-Instanz oder Anwendung.userUid
: Eindeutiger Identifikator für den Benutzer (optional).
Beispiel:
Anpassung
Erweitern Sie das <blockbrain-main>
-Tag und passen Sie es durch verschiedene Attribute an Ihre Bedürfnisse an:
Beschreibungen der Attribute
iconUrl
(optional)Beschreibung: URL zu einem Standard-Icon-Bild, das für alle Nachrichten verwendet wird, wenn keine spezifische
iconUrl
für die Nachricht angegeben ist.Anpassung: Verwenden Sie die
iconUrl
-Eigenschaft innerhalb einer spezifischen Statusnachricht, um diesen Standard zu überschreiben.Icon ausblenden: Um das Icon für eine Nachricht auszublenden, setzen Sie deren
iconUrl
auf einen leeren String (""
).Beispiel:
"[https://example.com/default-icon.png](https://example.com/default-icon.png)"
iconSize
(optional)Beschreibung: Legt die Größe des Standard-Icons fest.
Anpassung: Sie können die Größe für eine bestimmte Statusnachricht überschreiben, indem Sie deren iconSize angeben.
Werte: Akzeptiert jede gültige CSS-Größe (z.B. 50px, 4rem, 100%).
messages
(optional)Beschreibung: Ein JSON-String, der es ermöglicht, die Titel und Beschreibungen für verschiedene Status anzupassen.
Struktur: Das
messages
-Attribut ist ein JSON-String, der es ermöglicht, das Erscheinungsbild jedes Status anzupassen. Jeder Status hat die folgenden anpassbaren Eigenschaften:iconUrl
(optional): URL zu einem Icon speziell für diesen Status. Verwenden Sie einen leeren String (""
) zum Ausblenden.iconSize
(optional): Überschreibt die Standard-iconSize
für diesen Status.title
(optional): Überschriftentext für den Status. Verwenden Sie einen leeren String (""
) zum Ausblenden.description
(optional): Text, der unter dem Titel angezeigt wird. Verwenden Sie einen leeren String (""
) zum Ausblenden.
Status:
notCreated
: Wird angezeigt, wenn kein Bot für die angegebenebotUid
gefunden wird. Der Benutzer muss möglicherweise den Bot anfordern.completed
: Wird angezeigt, wenn die Bot-Einrichtung abgeschlossen ist, mit optionalem Weiterleitungshinweis.requested
: Die Bot-Anfrage wurde übermittelt, und der Bot wird in wenigen Sekunden bereit sein. Der Benutzer muss möglicherweise die Seite aktualisieren, um den Bot anzuzeigen.needAttention
: Erfordert Admin- oder Benutzeraktion, um mit der Bot-Einrichtung fortzufahren.rejected
: Wird angezeigt, wenn die Bot-Anfrage abgelehnt wurde.loading
: Wird während der Initialisierung oder anderen Ladevorgängen angezeigt.error
: Zeigt einen Fehler während des Bot-Einrichtungsprozesses an.login
: Wird auf der Anmeldeseite angezeigt.
Last updated