Integration Hub

Integration Hub bietet eine standardisierte Methode für die Integration von CXone in die Authentifizierungs- und Webdienste von Drittanbietern. Bei Webdiensten kann es sich um Anwendungen, Plattformen oder Systeme handeln.

Integration Hub ist eine der verfügbaren Verfahren für die Arbeit mit REST-API-Aufrufen in CXone. Integration Hub bietet den Vorteil, dass Sie die Verbindung hinzufügen und an zahlreichen Stellen verwenden können. Bei anderen Methoden müssen Sie die Verbindung jedes Mal explizit erstellen, wenn Sie sie verwenden möchten.

Zusätzlich bietet Integration Hub erweiterte Sicherheit, z. B. MTLS und Geheimnisse. Variablen, die Sie als Geheimnis hinzugefügt haben, werden verschlüsselt und können nicht direkt abgerufen werden.

Verbindungen und Verbindungsvorlagen

Verbindungen definieren die Details der API-Anforderungen, Authentifizierungsdetails und Variablen, die Sie in CXone verwenden möchten.  Eine Verbindung muss nicht alle Arten von Verbindungsinformationen enthalten. Sie kann eine beliebige Kombination der unterstützten Informationsarten beinhalten.

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, wie Abrufen von Daten oder Erstellen von Datensätzen.

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. Sie beinhalten:

• NICE CXone Dev Portal: Ist in die im API-Entwicklerportal verfügbaren Endpunkte integriert, um Ihre Abhängigkeit von Studio Framework-Aktionen zu verringern. Verwendet OAuth 2.0-Authentifizierung. Zur Bestimmung der Authentifizierung verwendet es die Discovery-URL. Es unterstützt keine Clientzertifikate.

Systemvorlagen und von Ihnen erstellte Vorlagen können nicht geä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.

Vorlagen stehen in Integration Hub in der Verbindungsbibliothek zur Verfügung. Verbindungen werden in Integration Hub unter "Meine Verbindungen" aufgelistet. Sie können maximal 50 Verbindungen erstellen. Die Anzahl der Vorlagen ist nicht beschränkt.

Anträge

Anforderungen sind API-Aufrufe. Sie geben die folgenden Informationen an, die verwendet werden, um eine Verbindung mit einem Webdienst herzustellen:

• 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, um Informationen mit einer API-Anforderung zu übergeben. 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

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

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 Kennwö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 sind im Ruhezustand verschlüsselt. Integration Hub verwendet AES (Advanced Encryption Standard) zum Verschlüsseln der Daten. Sie werden in einer verschlüsselten Datenbank gespeichert. 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-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 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.