In Microsoft Flow können Sie Workflows ohne Code erstellen. In einigen Fällen aber müssen Sie erweiterte Microsoft Flow-Funktionen verwenden, und Webdienste sind gut dafür geeignet. Der Flow kann eine Verbindung mit einem Dienst herstellen, Vorgänge ausführen und Daten abrufen. Wenn Sie einen Webdienst haben, den Sie mit Microsoft Flow verbinden möchten, können Sie den Dienst als benutzerdefinierten Connector registrieren. Microsoft Flow kann dann die Eigenschaften Ihrer Web-API analysieren, einschließlich der erforderlichen Authentifizierung, der unterstützten Vorgänge sowie der Parameter und Ausgaben der einzelnen Vorgänge.

In diesem Thema betrachten wir die Schritte, die erforderlich sind, um einen benutzerdefinierten Connector zu registrieren und zu verwenden. Dazu nutzen wir die Textanalyse-API von Azure Cognitive Services. Die API erkennt die Sprache, die Stimmung und wichtige Begriffe in einem Text.

Voraussetzungen

  • Ein Microsoft Flow-Konto
  • Eine OpenAPI 2.0-Datei (ehemals Swagger) im JSON-Format und die URL einer OpenAPI-Definition oder eine Postman Collection für die API Wenn Sie über keines von beiden verfügen, finden Sie hier Unterstützung.
  • Ein Bild, das als Symbol für den benutzerdefinierten Connector verwendet wird (optional)

Schritte zum benutzerdefinierten Connector

Der benutzerdefinierte Connector wird in mehreren Schritten eingerichtet, die wir unten kurz beschreiben. In diesem Artikel wird vorausgesetzt, dass Sie bereits über eine RESTful-API verfügen, bei der Zugriffe über eine Authentifizierungsmethode erfolgen. Daher konzentrieren wir uns im weiteren Artikel auf Schritte 3 bis 6. Beispiele für Schritte 1 und 2 finden Sie unter Erstellen einer benutzerdefinierten Web-API für Microsoft Flow.

  1. Beim Erstellen einer RESTful-API können Sie eine Sprache und Plattform Ihrer Wahl festlegen. Als Microsoft-Technologien empfehlen wir eine der Folgenden (Sie können eine beliebige Plattform verwenden):

    • Azure Functions
    • Azure-Web-Apps
    • Azure-API-Apps
  2. Zum Sichern der API können Sie eine der folgenden Authentifizierungsmethoden verwenden: Zwar können Sie den Zugriff auf Connectors ohne Authentifizierung gestatten, dies ist aber nicht empfehlenswert.

  3. Zum Beschreiben der API stehen zwei branchenübliche Optionen zur Verfügung. Mit beiden kann die Verbindung zwischen der API und Microsoft Flow hergestellt werden.

    • Eine OpenAPI-Datei
    • Eine Postman Collection

    Während Sie die Registrierung vorbereiten (Schritt 4), können Sie eine OpenAPI-Datei auch selbst erstellen.

  4. Zum Registrieren des benutzerdefinierten Connectors verwenden Sie einen Assistenten in Microsoft Flow, der Ihnen die Beschreibung der API sowie die Eingabe von Sicherheits- und weiteren Informationen erleichtert.

  5. Das eigentliche Verwenden des benutzerdefinierten Connectors erfolgt in einer App. Sie stellen in der App eine Verbindung mit dem Connector her. Dann können Sie Vorgänge aufrufen, die in der API verfügbar sind (wie bei Standardverbindungen in Microsoft Flow).

  6. Das Freigeben des benutzerdefinierten Connectors entspricht der Freigabe anderer Ressourcen in Microsoft Flow. Dieser Schritt ist optional, oft ist es aber sachdienlich, benutzerdefinierte Connectors mehreren Erstellern von Apps per Freigabe zur Verfügung zu stellen.

Beschreiben der API

Angenommen, Sie haben eine API mit einer authentifizierten Zugriffsmethode. Dann muss die API beschrieben werden, damit Microsoft Flow eine Verbindung herstellen kann. Zu diesem Zweck erstellen Sie entweder eine OpenAPI-Datei oder eine Postman Collection – über einen beliebigen REST-API-Endpunkt, einschließlich:

  • Öffentlich verfügbarer Connectors. Zu diesen zählen beispielsweise Spotify, Uber, Slack, Rackspace und weitere.
  • Einer API, die Sie erstellen und für einen beliebigen Cloudhostinganbieter, z.B. Amazon Web Services (AWS), Heroku, Azure-Web-Apps, Google Cloud u.a., bereitstellen.
  • Eine in Ihrem Netzwerk bereitgestellte, benutzerdefinierte branchenspezifische API, solange die API für das öffentliche Internet verfügbar gemacht wird.

OpenAPI 2.0 (ehemals Swagger) und Postman Collections verwenden unterschiedliche Formate. In beiden Formaten sind Dokumente aber in allen Sprachen maschinenlesbar und enthalten eine Beschreibung der in der API enthaltenen Vorgänge und Parameter.

  • Zum Generieren dieser Dokumente stehen (für verschiedene Sprachen und Plattformen, auf denen die API basiert) verschiedene Tools zur Verfügung. Eine OpenAPI-Beispieldatei finden Sie in der Textanalyse-API-Dokumentation.
  • Wenn Sie weder bereits über eine OpenAPI-Datei für die API verfügen, noch selbst eine erstellen möchten, können Sie den benutzerdefinierten Connector auch ganz einfach mit einer Postman Collection erstellen. Weitere Informationen finden Sie unter Erstellen einer Postman Collection.
  • Microsoft Flow verwendet OpenAPI in jedem Fall, die Postman Collection wird analysiert und in eine OpenAPI-Beschreibungsdatei übersetzt.

Hinweis: Die Datei muss kleiner als 1 MB sein.

Erste Schritte mit OpenAPI und Postman

Registrieren eines benutzerdefinierten Connectors

Mit der OpenAPI-Datei oder Postman Collection können Sie den benutzerdefinierten Connector jetzt bei Microsoft Flow registrieren.

  1. Wählen Sie auf flow.microsoft.com in der oberen Menüleiste das Zahnrad (Einstellungen) aus. Wählen Sie die Option Benutzerdefinierte Connectors aus.

    Erstellen eines benutzerdefinierten Connectors

  2. Wählen Sie Benutzerdefinierten Connector erstellen aus.

    Eigenschaften des benutzerdefinierten Connectors

  3. Wählen Sie auf der Registerkarte Allgemein eine der Optionen zum Erstellen des benutzerdefinierten Connectors aus.

    • OpenAPI hochladen
    • OpenAPI-URL einfügen
    • Postman Collection V1 hochladen

    Erstellen des benutzerdefinierten Connectors

    Laden Sie ein Symbol für den benutzerdefinierten Connector hoch. Die Felder „Beschreibung“, „Host“ und „Basis-URL“ werden meist automatisch mit den Informationen aus der OpenAPI-Datei ausgefüllt. Wenn sie nicht automatisch ausgefüllt werden, können Sie die Informationen auch eingeben. Wählen Sie Weiter aus.

  4. Legen Sie auf der Registerkarte Sicherheit die Eigenschaften für die Authentifizierung fest.

    Authentifizierungstypen

    • Der Authentifizierungstyp wird basierend auf der im OpenAPI-Objekt securityDefinitions vorliegenden Definition automatisch ausgefüllt. Ein Beispiel für OAuth2.0:

      "securityDefinitions": {
          "AAD": {
          "type": "oauth2",
          "flow": "accessCode",
          "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
          "tokenUrl": "https://login.windows.net/common/oauth2/token"
          "scopes": {}
          }
      },
      
    • Wenn in der OpenAPI-Datei das securityDefintions-Objekt nicht verwendet wird, sind keine zusätzlichen Werte erforderlich.

    • Wenn Sie eine Postman Collection verwenden, wird der Authentifizierungstyp nur bei unterstützten Typen (z.B. bei OAuth 2.0 oder der Standardauthentifizierung) automatisch ausgefüllt.

    • Ein Beispiel zum Einrichten der AAD-Authentifizierung (Azure Active Directory) finden Sie unter Erstellen einer benutzerdefinierten Web-API für Microsoft Flow.

  5. Auf der Registerkarte Definitionen werden alle Vorgänge, die in der OpenAPI-Datei oder Postman Collection definiert sind, sowie die entsprechenden Werte für Anforderungen und Antworten automatisch ausgefüllt. Wenn alle benötigten Vorgänge definiert sind, können Sie mit Schritt 6 zur Registrierung fortfahren und diesen Bildschirm unverändert lassen.

    Registerkarte „Definitionen“

    Wenn Sie vorhandene Aktionen bearbeiten oder einem benutzerdefinierten Connector neue hinzufügen möchten, lesen Sie unten weiter.

    1. So fügen Sie eine neue Aktion hinzu, die nicht bereits in der OpenAPI-Datei oder Postman Collection enthalten ist: Wählen Sie Neue Aktion aus (im linken Bereich); geben Sie dann im Abschnitt Allgemein einen Namen, eine Beschreibung und die Sichtbarkeit für den Vorgang ein.
    2. Wählen Sie im Abschnitt Anforderung oben rechts Aus Beispiel importieren aus. Fügen Sie im Formular auf der rechten Seite eine Beispielanforderung ein. Beispielanforderungen finden Sie in der API-Dokumentation. Dort erhalten Sie Informationen zum Ausfüllen der Felder Verb, Anforderungs-URL, Header und Text. Ein Beispiel finden Sie in der Textanalyse-API-Dokumentation.
    Wichtig:

    Sie müssen den Content-type-Header aus Aktionen entfernen, da diese Informationen von Microsoft Flow automatisch hinzugefügt werden. Authentifizierungsheader, die im Abschnitt Sicherheit definiert wurden, müssen ebenfalls aus Aktionen und Triggern entfernt werden.

    Importieren aus einem Beispiel 3. Wählen Sie Import aus. Damit ist die Anforderungsdefinition abgeschlossen. Gehen Sie genau so vor, um die Antwort zu definieren.

  6. Sobald alle Vorgänge definiert sind, wählen Sie Erstellen aus. Der benutzerdefinierte Connector ist jetzt verfügbar.

  7. Rufen Sie die Registerkarte Test auf, um die Vorgänge des benutzerdefinierten Connectors, die in der API definiert sind, zu testen. Wählen Sie eine Verbindung aus, und geben Sie zum Testen eines Vorgangs Eingabeparameter an.

    Testen des Benutzerdefinierten Connectors

    Wenn der Aufruf erfolgreich ist, erhalten Sie eine gültige Antwort.

    Testen der Connector-Antwort

Kontingent und Drosselung

  • Einzelheiten zu Kontingenten beim Erstellen von benutzerdefinierten Connectors finden Sie auf der Seite mit Preisen für Microsoft Flow. Benutzerdefinierte Connectors, die Sie als Freigabe nutzen, werden nicht mit den Kontingenten verrechnet.
  • Benutzer können für jede erstellte Verbindung mit einem benutzerdefinierten Connector bis zu 500 Anforderungen pro Minute ausführen.

Freigeben des benutzerdefinierten Connectors

Sie können den benutzerdefinierten Connector jetzt für andere Benutzer in Ihrer Organisation freigeben. Denken Sie daran, dass andere später vielleicht auf Ihren benutzerdefinierten Connector angewiesen sind – wenn Sie ihn löschen, gehen alle Verbindungen mit dem Connector verloren. Wenn Sie einen Connector für Benutzer außerhalb Ihrer Organisation bereitstellen möchten, finden Sie Informationen dazu unter Übersicht über das Zertifizieren von benutzerdefinierten Connectors in Microsoft Flow.

  1. Wählen Sie auf flow.microsoft.com in der oberen Menüleiste das Zahnrad (Einstellungen) aus. Wählen Sie die Option Benutzerdefinierte Connectors aus.

    Neue Verbindung

  2. Wählen Sie die Schaltfläche mit den Auslassungspunkten (...) und dann Eigenschaften anzeigen aus.

    Anzeigen der Eigenschaften des Connectors

  3. Wählen Sie Freigeben aus, und geben Sie dann die Benutzer oder Gruppen ein, denen Sie Zugriff auf den Connector gewähren möchten.

    Freigeben eines benutzerdefinierten Connectors

  4. Wählen Sie Speichern aus.

Weitere Schritte

Erstellen einer Postman Collection

Informationen über benutzerdefinierte OpenAPI-Erweiterungen

Verwenden einer ASP.NET-Web-API

Registrieren einer Azure Resource Manager-API