Integration Hub

Integration Hub bietet eine zentrale Anlaufstelle für die Integration mit externen Systemen und Diensten. Es ermöglicht Ihnen, standardisierte REST APIGeschlossen Application Programming Interface. Ermöglicht Ihnen die Automatisierung bestimmter Funktionen durch das Verbinden Ihres CXone Mpower-Systems mit anderer Software.-Verbindungen zu erstellen, die Sie in mehreren Studio-Skripten verwenden können. Dadurch entfällt die Notwendigkeit, dieselben Anfragen immer wieder neu zu erstellen, wenn Sie extern über eine API kommunizieren möchten. Stattdessen können Sie die Anfrage einmal in Integration Huberstellen und sie dann überall dort wiederverwenden, wo Sie sie benötigen. Dies vereinfacht und beschleunigt den Skripting-Prozess.

Integration Hub macht Ihre Integrationen außerdem sicherer. Es verschlüsselt die API-Zugangsdaten, sodass diese bei jeder Verwendung nicht im Skript offengelegt werden. Studio-Skripte werden als Klartext gespeichert, daher können Sie wichtige Anmeldeinformationen, wie z. B. Tokens für API-Anfragen, nicht sicher als Variablen direkt im Skript speichern. Integration Hub ermöglicht es Ihnen, schnell eine Authentifizierungsanforderung zu einem Skript hinzuzufügen und die abgerufenen Anmeldeinformationen dann sicher in nachfolgenden API-Aufrufen zu verwenden. Sie können auch mTLS-Zertifikate zu einer API-Anfrage hinzufügen.

Integration Hub ist Teil der Automatisierung & KI App in CXone Mpower. Wenn Sie die Berechtigung Launch Automation & AI verfügen, können Sie App von CXone Mpower in einem neuen Fenster öffnen und auf Integration Hubklicken.

Integration Hub mit der Liste "Meine Verbindungen" links und der Verbindungsbibliothek rechts.

Verbindungen

Verbindungen definieren die Details für die Integration mit einem externen Dienst, wie API-Anfragen, Authentifizierungsabläufe und Variablen. Beispielsweise könnten Sie eine Verbindungsvorlage für Salesforceerstellen. Hiermit würden die grundlegenden Details definiert, die für die Verbindung mit Salesforceerforderlich sind, wie z. B. Authentifizierungstyp und unterstützte Methoden. Aus dieser Vorlage erstellen Sie eine Verbindung, mit der Sie bestimmte Details aus der Vorlage sowie weitere spezifische Details wie die spezifischen API-Anfragen, die Sie an Salesforcesenden möchten, eingeben können.

Verbindungsvorlagen

Jede Verbindung, die Sie in Integration Hub hinzufügen, wird auf Basis einer Verbindungsvorlage erstellt. Vorlagen definieren die grundlegenden Informationen für alle Verbindungen, die mithilfe der jeweiligen Vorlage erstellt werden. Dies beinhaltet:

  • Der Name des Webdienstes, mit dem Sie eine Verbindung herstellen.
  • Die Integrationsmethode. Derzeit ist die REST-API die einzige unterstützte Methode.
  • Der Authentifizierungstyp, sofern zutreffend. Derzeit können Sie OAuth 2.0 verwenden oder auf die Authentifizierung verzichten.
  • Die eigenen Kopfzeilen für die Authentifizierung, sofern erforderlich.
  • Die Verben, die für Anforderungen auf Basis der Vorlage verfügbar sind. Verben sind die Aktionen, die mit dem verbundenen Webdienst ausgeführt werden können, z. B. das Abrufen von Daten (GET) oder das Erstellen von Datensätzen (POST).

Eine Verbindung muss nicht alle Arten von Verbindungsinformationen enthalten. Sie kann eine beliebige Kombination der unterstützten Informationsarten beinhalten.

Alle Verbindungsvorlagen sind in der Verbindungsbibliothek in Integration Hubverfügbar. Vorlagen, die Sie in einem Studio-Skript verwenden können, sind unter Meine Verbindungen in Integration Hubaufgelistet. Sie können maximal 50 Verbindungen erstellen (in der Liste „Meine Verbindungen“). Die Anzahl der Vorlagen in der Verbindungsbibliothek ist nicht begrenzt.

Nicht alle Vorlagen können verändert werden. Ihre eigenen Vorlagen können jedoch gelöscht werden. Wenn Sie etwas in einer eigenen Vorlage später ändern möchten, müssen Sie die Vorlage löschen und eine neue Vorlage erstellen. Verbindungen selbst können geändert werden. Das Löschen einer eigenen Vorlage wirkt sich nicht auf die Verbindungen aus, die mit dieser Vorlage erstellt wurden.

Systemvorlagen

Integration Hub hat zwei Arten von Vorlagen: Systemvorlagen in Besitz von NiCE und -Vorlagen, die Sie selbst erstellen. Systemvorlagen werden mit Integration Hub mitgeliefert und können nicht gelöscht werden. Derzeit enthält Integration Hub eine Systemvorlage:

  • CXone Mpower Dev Portal: Integriert sich mit API-Endpunkten, die im CXone Mpower Developer Portal dokumentiert sind. Dadurch wird Ihre Abhängigkeit von Studio Framework-Aktionen verringert. Verwendet OAuth 2.0-Authentifizierung. Zur Bestimmung der Authentifizierung verwendet es die Discovery-URL. Es unterstützt keine Clientzertifikate.

Anträge

Anforderungen sind API-Aufrufe. Für jede Verbindung in der Liste „Meine Verbindungen“ können Sie Anfragen hinzufügen, die Sie mit dem jeweiligen externen Dienst verwenden möchten. Diese Anfragen enthalten die folgenden Informationen, die zur Verbindung mit einem Webdienst verwendet werden:

  • URL: Der Ort der Ressource, mit der Sie eine Verbindung herstellen.
  • Methode (Verb): Die Aktion, die die Anforderung durchführen soll, beispielsweise Abrufen von Daten oder Erstellen eines neuen Datensatzes. Integration Hub unterstützt diese Verben: GET, PUT, POST, DELETE, TRACE, PATCH, HEAD, OPTIONS. Die für eine Verbindung verfügbaren Verben werden in der Vorlage definiert, mit der die Verbindung erstellt wird.
  • Kopfzeile: Ein Teil der Anforderung, der zusätzliche Informationen über die Anforderung enthält. Dies sind beispielsweise die Sprache oder Anmeldeinformationen.
  • Abfrageparameter: Eine Möglichkeit, Informationen mit einer API-Anfrage in der Endpunkt-URL weiterzugeben. Sie werden als Schlüssel-Wert-Paare konfiguriert. Damit können die in der Antwort zurückgegebenen Daten gefiltert, sortiert, angepasst oder gesteuert werden.
  • Haupttext: Der Inhalt der Anforderung. Das Format richtet sich nach den Anforderungen der API, mit der Sie eine Verbindung herstellen. Die Medienart des Haupttextes muss zu der Ressource passen, mit der Sie eine Verbindung herstellen. Sie wird auch als MIME-Typ oder Inhaltstyp bezeichnet. Dies sind unterstützte Optionen und zugehörige Inhalts-Kopfzeilen.
    • ApplicationJson: application/json
    • ApplicationJsonPatch: application/json-patch+json
    • FormURLEncoded: application/x-www-form-urlencoded
    • TextHtml: text/html
    • TextPlain: text/plain
    • TextXml: text/xml
    • Sigv4: application/ x-amz-json-1.1

Jede Integration Hub-Verbindung kann bis zu 50 Anfragen haben. Es gibt keine Einschränkung für die Anzahl der gleichzeitig aktiven Anfragen.

In CXone Mpower gilt ein Höchstwert von 32 KB für die Größe der Antworten. Verwenden Sie Abfrageparameter zum Filtern der zurückgegebenen Daten. Dies kann Ihnen helfen, den Grenzwert einzuhalten.

Manuelle und Studio-Anforderungen

Integration Hub unterstützt zwei Optionen für die Anforderungen in Verbindungen:

  • Manuell: Eine manuelle Anforderung wird in Integration Hub mit den Optionen auf der Seite "Anforderung hinzufügen" erstellt. Hier können Sie Geheimnisse verwenden. Manuelle Anforderungen werden häufig verwendet, wenn sich die Daten nicht ändern. Sie können direkt in Integration Hub ausgeführt werden, ohne dass ein Studio-Skript erforderlich ist. Sie können auch in Studio-Skripten ausgeführt werden.

  • Studio: In einigen Fällen können API-Anforderungen nicht als manuelle Anforderungen in Integration Hub erstellt werden. Beispielsweise müssen Anforderungen, die Pfadparameter oder die Variablenersetzung erfordern oder die eine Verbindung mit SOAP-Webdiensten herstellen, in einem Studio-Skript erstellt werden. Es empfiehlt sich, diese Anforderungen in Ihren Integration Hub-Verbindungen nachzuverfolgen. Dies ist mit der Studio-Anforderungsoption möglich. Eine Studio-Anforderung wird auf der Registerkarte "Anforderungen" der Verbindung zusammen mit allen ihren manuellen Anforderungen angezeigt.

Variablen

Integration Hub ermöglicht Ihnen das Speichern von Wertpaaren als Variablen. Variablen sind standardmäßig unverschlüsselt. Sie können eine Variable verschlüsseln, indem Sie sie in ein Geheimnis umwandeln. Das Umwandeln einer Variablen in ein Geheimnis bietet zusätzliche Sicherheit für sensible Informationen wie Passwörter oder Schlüssel.

Variablen können in der Verbindung verwendet werden, in der Sie sie erstellen. Wenn Sie eine Verbindung oder eine Authentifizierungsanforderung in einem Studio-Skript ausführen, können Sie Variablen von dieser Verbindung im Skript verwenden.

Geheimnisse werden im Ruhezustand in einer verschlüsselten Datenbank verschlüsselt. Integration Hub verwendet AES (Advanced Encryption Standard) zum Verschlüsseln der Daten. Die Daten werden nur bei der Ausführung entschlüsselt.

Integration HubStudio-Aktionen

Wenn Sie in einem Studio-Skript die Authentifizierung verwenden oder eine Anforderung tätigen möchten, verwenden Sie die folgenden Studio-Aktionen:

  • CONNECTAUTH: Mithilfe dieser Aktion können Sie Authentifizierungsdetails oder Geheimnisse in Ihr Skript einschließen. Die Authentifizierungsdetails und Variablen müssen in einer Integration Hub-Verbindung definiert sein.
  • CONNECTREQUEST: Mithilfe dieser Aktion können Sie eine Anforderung verwenden, die in einer Integration Hub-Verbindung definiert ist. Diese Aktion ist für die Verwendung von manuellen Anforderungen und Studio-Anforderungen erforderlich.

Wichtige Fakten über Integration Hub Studio-Aktionen

  • Sie erfordern Integration Hub. Wenn Integration Hub in Ihrem CXone Mpower-System nicht aktiviert ist, funktionieren die Aktionen nicht.
  • Sie können mehr als eine Instanz jeder Aktion in Ihr Skript aufnehmen.
  • Sie können mithilfe der Variablenersetzung verschiedene Anforderungen ausführen oder die Authentifizierung aus mehr als einer Verbindung in einem einzelnen Skript verwenden.
  • Wie bei anderen Methoden für API-Aufrufe in CXone Mpower muss das Skript zusätzlich konfiguriert werden, damit die Antwort vom verbundenen Webdienst empfangen und ordnungsgemäß verarbeitet werden kann.
  • CONNECTAUTH ermöglicht keine Anpassung. Die Authentifizierungsanforderung wird so ausgeführt, wie sie in der Verbindung in Integration Hub definiert ist.

Sicherungsschalter

Integration Hub hat einen eingebauten Leistungsschalter. Es handelt sich um eine vorsorgliche Sicherheitsmaßnahme für fehlgeschlagene API-Aufrufe. Wenn der Circuit Breaker erkennt, dass ein Aufruf wiederholt fehlschlägt, wird er aktiviert und drosselt den API-Aufruf. Der häufigste Grund für fehlgeschlagene Aufrufe sind temporäre Serverfehler (500-Fehler). Durch Drosselung (oder Pausierung) des Anrufs erhält der Server Zeit, wieder hochzufahren und ordnungsgemäß zu funktionieren.

Die wichtigsten Merkmale des Leistungsschalters sind:

  • Der Sicherungsschalter wird aktiviert, wenn mehr als 50 % der Aufrufe einer API innerhalb von 30 Sekunden fehlschlagen.

  • Um den Sicherungsschalter auszulösen, muss Integration Hub also mehr als 100 Aufrufe einer einzelnen API innerhalb eines 30-Sekunden-Zeitraums versucht haben.

  • Der Sicherungsschalter wird für 30 Sekunden aktiviert.

  • Die Fehlerursachen sind in den Studio trace Protokollen abrufbar, die in der _err Variablen gespeichert sind.

Auditverlauf

Jede Verbindung in Integration Hub verfügt über ein Änderungsprotokoll. Jedes Mal, wenn eine Verbindung hergestellt oder aktualisiert wird, werden die folgenden Details protokolliert:

  • Datum: Wann die Änderung vorgenommen wurde.

  • Geändert von: Wer die Änderung vorgenommen hat.

  • Profilname: Der Name der Verbindung.

  • Aktion: Was passiert ist, z. B. ob eine Verbindung erstellt oder geändert wurde.

Die Benutzer können über eine neue Schaltfläche Audit in den Verbindungseinstellungen auf dieses Protokoll zugreifen.