Benutzerdefinierte Connectors

Fügen Sie Ihre eigenen Verbindungen und Aktionen zu Workflows mit Ihren vorhandenen Unternehmenssystemen und Drittanbieterdiensten hinzu. Benutzerdefinierte Connectors verwenden REST APIs für die Kommunikation und das API-Entwicklungstool Postman zum Erstellen von Standardanforderungen.

Automatisieren Sie Ihre internen Dienste mit benutzerdefinierten Connectors

Wenn der Dienst REST APIs und JSON-Inhaltstypen unterstützt, können Sie ihn in Ihren Workflows mit benutzerdefinierten Connectors verwenden.

Postman zum Erstellen von standardmäßigen REST APIs

Workspace ONE Intelligence verwendet Postman, um die REST APIs zu standardisieren, die das System für die Verbindung mit ihren internen und Drittanbieterdiensten verwendet. Es erstellt Aktionen mithilfe einer vertrauten REST-Vorlagenschnittstelle, die die Wiederverwendung der gespeicherten Aktionen ermöglicht. Die kostenlose Version von Postman verfügt über die Funktionen, die zum Erstellen von Sammlungen für benutzerdefinierte Connectors erforderlich sind.

Schritte zur Verwendung von benutzerdefinierten Konnektoren

Erstellen Sie eine Sammlung mit Anforderungen in Postman und exportieren Sie sie.
Fügen Sie in Workspace ONE Intelligence eine benutzerdefinierte Verbindung hinzu und importieren Sie die Anforderungen. Diese Anforderungen sind jetzt als Aktionen verfügbar, die Sie in Workflows verwenden können.
Konfigurieren Sie einen Workflow mit importierten Aktionen, um eine Aufgabe mithilfe Ihrer benutzerdefinierten Verbindung in Workspace ONE Intelligence zu automatisieren.

Aktionen für benutzerdefinierte Konnektoren

Sie können in Workspace ONE Intelligence benutzerdefinierte Connectors bearbeiten, löschen und testen. Sie können Aktionen in mehreren Connectors verwenden, um die Folgen der Bearbeitung oder Löschung zu berücksichtigen, bevor Sie handeln.

Löschen: Um eine gesamte Verbindung und alle zugehörigen Aktionen zu löschen, müssen Sie sie zuerst deaktivieren. Nach der Deaktivierung ist jeder Workflow, der eine mit dieser Verbindung verknüpfte Aktion verwendet, deaktiviert. Nachdem das System die Verbindung gelöscht hat, werden alle zugehörigen Aktionen von anderen Workflows entfernt. Sie müssen die deaktivierten Workflows bearbeiten und erneut aktivieren, um sie erneut auszuführen. Diese Aktion kann nicht rückgängig gemacht werden.
Bearbeiten: Sie können den Verbindungsnamen, die Beschreibung und die Authentifizierungstypen jederzeit bearbeiten. Um die Anforderungsdetails der Aktion zu bearbeiten, bearbeiten Sie die Postboten-Sammlung und importieren Sie sie dann erneut in Ihre benutzerdefinierte Verbindung. Hinweis: Wenn Sie Authentifizierungstypen bearbeiten und die Anmeldedaten nicht ordnungsgemäß eingeben, können Aktionen nicht ausgeführt werden. Gehen Sie beim Bearbeiten mit Bedacht vor.
Testen: Testen Sie benutzerdefinierte Connectors in Workspace ONE Intelligence, um sich zu vergewissern, dass Workspace ONE Intelligence und Ihr Dienst kommunizieren können.

Registrieren eines benutzerdefinierten Connectors

Um eine benutzerdefinierte Verbindung hinzuzufügen, importieren Sie Ihre Postman-Sammlung. Die Anforderungen in der Postman-JSON-Datei sind die Aktionen. Nach dem Import der Sammlung stehen die Aktionen für die Verwendung in Workflows zur Verfügung.

Voraussetzungen

Erstellen Sie mithilfe des unter „Verwenden von Postman für benutzerdefinierte Connectors“ beschriebenen Prozesses eine Sammlung.
Der Dienst, den Sie verbinden möchten, muss die REST API und JSON-Inhaltstypen unterstützen.
Workspace ONE Intelligence benötigt Zugriff auf API-Endpoints. Wenn die Dienste sich hinter einer Firewall befinden, verwenden Sie Unified Access Gateway als Reverse-Proxy.
Wenn Sie OAuth2 für die Authentifizierung verwenden, sorgen Sie für Autorisierungsdetails, mit denen Workspace ONE Intelligence Token für den Dienst abrufen, aktualisieren und darauf zugreifen kann.
- OAuth2-Token-URL
- Geheimer Clientschlüssel
- Client-ID
- Gewährungstyp (Client-Anmeldedaten oder Kennwort)

Verfahren

Navigieren Sie in Workspace ONE Intelligence zu Integrationen > Workflow-Connectors und wählen Sie Benutzerdefinierten Connector hinzufügen aus.
Geben Sie unter Connector-Name einen aussagekräftigen Namen für die Verbindung ein.
Geben Sie unter Basis-URL die URL für den Dienst ein, damit Workspace ONE Intelligence sich authentifizieren kann. Die URL für den Dienst und die URL für die benutzerdefinierte Verbindung müssen übereinstimmen.
Wählen Sie unter Authentifizierungstyp den Authentifizierungstyp aus, der für den Zugriff auf den Dienst verwendet werden soll. Workspace ONE Intelligence überschreibt in Sammlungen mit dieser Einstellung die Header der Postman-Authentifizierung. Wenn Ihr Dienst einen eindeutigen, Header-basierten Authentifizierungstyp verwendet, fügen Sie den Header allen Ihren Anforderungen in der Postman-Sammlung hinzu und konfigurieren Sie die BaseURL. In diesem Szenario verwendet Workspace ONE Intelligence die in der Postman-Sammlung konfigurierten Header. Beispiele für Header-basierte Authentifizierungstypen sind die Verwendung eines API-Schlüssels oder eines Tokens.
- Standardauthentifizierung: Ermöglicht Workspace ONE Intelligence Zugriff. Geben Sie die Anmeldedaten ein.
- OAuth2-Authentifizierung: Geben Sie die Details ein, damit Workspace ONE Intelligence die Token für den Dienst abrufen, aktualisieren und darauf zugreifen kann.
- Keine Authentifizierung: Wenn Sie nicht möchten, dass Workspace ONE Intelligence die Authentifizierungs-Header außer Kraft setzt, wählen Sie dieses Menüelement aus.
Um Ihre Postman-JSON-Datei zu importieren, verwenden Sie den Link vom Computer auswählen in der Mitte der Benutzeroberfläche. Die Benutzeroberfläche zeigt die Sammlung mit ihren Anforderungen an. Diese Postman-Anforderungen sind jetzt als Aktionen für Workflows verfügbar.
In der Liste der importierten Aktionen können Sie die Aktion testen, bearbeiten und löschen.
- Löschen: Wenn eine Aktion, die Sie löschen möchten, in anderen Workflows verwendet wird, deaktiviert das System diese Workflows und entfernt die Aktion. Sie müssen Workflows bearbeiten und erneut aktivieren, damit sie weiterhin funktionieren. Das Löschen kann nicht rückgängig gemacht werden.
- Bearbeiten: Sie können die Namen und Beschreibungen der Aktionen bearbeiten. Das System erfasst Namen und Beschreibungen aus der importierten Postman-JSON. Um die Anforderungsdetails der Aktion zu bearbeiten, bearbeiten Sie die Postboten-Sammlung und importieren Sie sie dann erneut in Ihre benutzerdefinierte Verbindung.
- Testen: Verwenden Sie das Menüelement „Testen“, um sicherzustellen, dass die Verbindung funktioniert. Das System testet die in der Postman-Sammlung konfigurierte Anforderung.

Verwenden von Postman für benutzerdefinierte Connectors

Verwenden Sie die Postman-App, um standardmäßige REST APIs für benutzerdefinierte Connectors zu erstellen. Dieser Inhalt bietet einen allgemeinen Workflow für das Erstellen und Exportieren von Postman-Sammlungen als JSON-Dateien.

Die kostenlose Version der App verfügt über die Funktionen zum Erstellen von Sammlungen mit Anforderungen und zum Exportieren für Workflows.

Dieses Thema dient als allgemeiner Überblick darüber, was Sie tun müssen, um eine Sammlung zu erstellen und zu exportieren. Es ist als Referenz gedacht. Die neuesten Anweisungen zum Konfigurieren des Postman-Produkts finden Sie im Postman Learning Center.

Rufen Sie die Postman-App von https://www.getpostman.com ab.

Verfahren

Fügen Sie eine Sammlung hinzu.
Fügen Sie Anforderungen in der Sammlung hinzu, und konfigurieren Sie sie.
- Der in diesen Anforderungen bereitgestellte Name und die Beschreibung werden in den Workflow-Aktionen in Workspace ONE Intelligence verwendet. Sie können diese zu einem späteren Zeitpunkt in Workspace ONE Intelligence ändern. Hier ist ein Beispiel für einen Eintrag in einer Postman-Anforderung und dafür, wie diese als eine Aktion in Workflows in Workspace ONE Intelligence gerendert wird.
- Sie sollten Header als Content-Type: application/json hinzufügen. Wenn Sie keine Header mit dem Inhaltstyp JSON hinzufügen, können die APIs standardmäßig XML verwenden, und XML funktioniert nicht mit benutzerdefinierten Connectors.
- Fügen Sie alle benutzerdefinierten Header, die von Ihrer API benötigt werden, allen Anforderungen in der Postman-Sammlung hinzu. Beispiele für benutzerdefinierte Header sind eindeutige Header-basierte Authentifizierungstypen wie ein API-Schlüssel oder ein Token. Workspace ONE Intelligence behält alle Header außer den Authentifizierungs-Headern bei. Es überschreibt Authentifizierungs-Header mit Ihren Konfigurationen für Auth-Typ in der benutzerdefinierten Sammlung. Wenn Workspace ONE Intelligence den Authentifizierungs-Header überschreibt, sendet das System weiterhin Ihre eindeutige, Header-basierte Authentifizierung zur Verwendung, da Sie sie zu anderen Anforderungen hinzugefügt haben.
Senden Sie die Anforderung, um sie zu validieren. Die Validierung generiert die Antwort.
Speichern Sie die Antwort als Beispiel für die Dokumentation. Das Open API-Protokoll erfordert diesen Schritt.
Speichern Sie die Anforderung.
Fügen Sie nach Bedarf weitere Anforderungen hinzu.
Exportieren Sie die Sammlung als Sammlung v2.1.