Einen benutzerdefinierten Connector auf der Grundlage einer Postman-Sammlung erstellen

Beschreiben Sie zum Erstellen eines benutzerdefinierten Connectors die API, mit der Sie eine Verbindung herstellen möchten, damit der Connector die Aktionen und Datenstrukturen der API versteht. In diesem Artikel erstellen Sie einen benutzerdefinierten Connector mit einer Postman-Sammlung , die die Cognitive Services Text Analytics Sentiment API (das Beispiel für diese Reihe) beschreibt.

Weitere Möglichkeiten zur Beschreibung einer API finden Sie in den folgenden Themen:

• Einen benutzerdefinierten Connector auf der Grundlage einer OpenAPI-Definition erstellen

• Erstellen Sie einen benutzerdefinierten Konnektor von Grund auf neu

Anforderungen

Überprüfen Sie die Voraussetzungen, um sicherzustellen, dass Sie über alles verfügen, was Sie zum Erstellen eines benutzerdefinierten Connectors benötigen. Voraussetzungen:

• Eine Postman-Sammlung, welche die Beispiel-API beschreibt. Befolgen Sie die Anweisungen in " Erstellen einer Postman-Sammlung für einen benutzerdefinierten Connector".

• Ein API-Schlüssel für die Cognitive Services-API zur Textanalyse.

• Eines der folgenden Abonnements:

  • Azure, wenn Sie Logic Apps verwenden
  • Power Automate
  • Power Apps

• Wenn Sie Logic Apps verwenden, erstellen Sie zunächst einen benutzerdefinierten Konnektor von Azure Logic Apps.

Postman-Sammlung importieren

Jetzt können Sie die postman-Sammlung verwenden, die Sie erstellt oder heruntergeladen haben. Die Sammlung enthält einen Großteil der erforderlichen Informationen. Sie können diese Informationen überprüfen und aktualisieren, während Sie den benutzerdefinierten Connector-Assistenten durchlaufen. Importieren Sie zunächst die Postman-Sammlung für Logik-Apps oder für Power Automate und Power Apps.

Importieren der Postman-Sammlung für Logic Apps

1. Gehen Sie zu Azure portal, und öffnen Sie den Konnektor Logic Apps, den Sie zuvor unter Einen benutzerdefinierten Konnektor für Azure Logic Apps erstellen erstellt haben.

2. Wählen Sie im Menü Ihres Konnektors Logic Apps Konnektor und dann Bearbeiten.

   

3. Wählen Sie unter AllgemeinPostmann-Sammlung V1 hochladen, und navigieren Sie dann zu der von Ihnen erstellten Postmann-Sammlung.

   

   Der Assistent importiert die Sammlung und konvertiert sie dann in eine OpenAPI-Definition mit dem Namen generatedApiDefinition.swagger.json.

Die Postman-Sammlung für Power Automate und Power Apps importieren

1. Navigieren Sie zu make.powerapps.com oder flow.microsoft.com.

2. Wählen Sie im Navigationsbereich Mehr>Alles entdecken aus.

3. Wählen Sie im Abschnitt „Benutzerdefinierte Connectoren“ im Abschnitt „Daten“ aus.

4. Wählen Sie Neuer benutzerdefinierte Connector und dann Postman-Sammlung importieren aus.

5. Geben Sie einen Namen für den benutzerdefinierten Konnektor ein, navigieren Sie dann zu der Postman-Collection, die Sie heruntergeladen oder erstellt haben, und wählen Sie Fortsetzen.

   

   Parameter	Wert
   Titel des benutzerdefinierten Connectors	„SentimentDemo“

   Der Assistent importiert die Auflistung und konvertiert sie in eine OpenAPI-Definition mit dem Namen generatedApiDefinition.swagger.json.

Allgemeine Informationen aktualisieren

Ab diesem Punkt zeigt dieser Artikel die Power Automate-Benutzeroberfläche, aber die Schritte sind meist in allen drei Technologien identisch. Bei Bedarf werden Unterschiede hervorgehoben.

1. Überprüfen Sie auf der Seite Allgemein die Informationen, die aus der Postman-Sammlung importiert wurden (einschließlich Host und Basis-URL für die API). Der Connector verwendet den Host und die Basis-URL, um zu bestimmen, wie die API aufgerufen wird.

   Anmerkung

   Weitere Informationen über die Verbindung zu lokalen APIs finden Sie unter Verbindung zu lokalen APIs über das Daten-Gateway.

2. Geben Sie eine aussagekräftige Beschreibung ein. Diese Beschreibung wird in den Details des benutzerdefinierten Connectors angezeigt und hilft anderen Benutzern zu verstehen, wie Ihr Connector nützlich ist.

   Parameter	Wert
   Beschreibung	„Verwendet das Cognitive Services Text Analytics Sentiment API, um festzustellen, ob Text positiv oder negativ ist“

Authentifizierungsart angeben

Benutzerdefinierte Connectors unterstützen mehrere Authentifizierungsoptionen. Die Cognitive Services-APIs verwenden Authentifizierung mit API-Schlüssel.

1. Wählen Sie auf der Seite Sicherheit unter Authentifizierungstyp die Option API-Schlüssel aus.

2. Geben Sie unter API-Schlüssel eine Beschreibung, einen Namen und einen Ort für den Parameter an. Wählen Sie eine aussagekräftige Beschriftung aus. Dieser Text wird Benutzern angezeigt, um sie beim Herstellen der Verbindung mit Ihrem benutzerdefinierten Connector anzuleiten. Der Parametername und der Speicherort müssen mit dem übereinstimmen, was die API erwartet (in diesem Fall der Header, den Sie in Postman angegeben haben). Wählen Sie Verbinden aus.

   

   Parameter	Wert
   Parameterbezeichnung	„API-Schlüssel“
   Parametername	„Ocp-Apim-Subscription-Key“
   Ort des Parameters	„Header“

3. Vergewissern Sie sich am Anfang des Assistenten, dass der Name auf „SentimentDemo“ gesetzt ist, und wählen Sie dann Konnektor erstellen.

Konnektordefinition überprüfen und aktualisieren

Der Assistent für benutzerdefinierte Konnektoren bietet viele Optionen zum Definieren der Funktionsweise Ihres Connectors und wie er in Logic Apps, Flows, Apps und Agents bereitgestellt wird. In diesem Abschnitt wird die Benutzeroberfläche erläutert und einige Optionen behandelt, Sie können aber selbst mehr erkunden.

Benutzeroberfläche und Definition überprüfen

Bevor Sie die Schritte auf der Definitionsseite ausführen, überprüfen Sie die Benutzeroberfläche.

1. In diesem Bereich werden alle Aktionen, Trigger (für Logik-Apps und Power Automate), Verweise und Richtlinien angezeigt, die für den Connector definiert sind. In diesem Fall wird die Aktion DetectSentiment aus der Postman-Sammlung angezeigt. Dieser Connector enthält keine Trigger. Sie finden Informationen zu Triggern für benutzerdefinierte Connectors unter Verwenden eines Webhooks als Trigger für Azure Logic Apps und Power Automate.

   

2. Der Bereich Allgemein enthält Informationen zur derzeit ausgewählten Aktion bzw. zum derzeit ausgewählten Trigger. Diese Informationen stammen aus der Postman-Sammlung. Sie können die hier angezeigten Informationen bearbeiten, u. a. die Eigenschaft für die Visibility von Vorgängen und Parametern in einer Logik-App oder einem Flow:

   • wichtig: wird dem Benutzer immer zuerst angezeigt
   • kein Wert: wird normalerweise in der logischen Anwendung oder im logischen Ablauf angezeigt
   • erweitert: zunächst in einem zusätzlichen Menü verborgen
   • intern: wird für den Benutzer nicht angezeigt

3. Der Bereich Anforderung zeigt Informationen an, die auf der HTTP-Anforderung basieren, die in der Postman-Sammlung enthalten ist. In diesem Fall sehen Sie, dass das HTTP-VerbPOST ist und die URL „/text/analytics/v2.0/sentiment“ lautet (die vollständige URL zur API ist <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment>). Sie sehen sich den Body-Parameter in Kürze genauer an.

4. Der Bereich Antwort zeigt Informationen an, die auf der HTTP-Antwort basieren, die in der Postman-Sammlung enthalten ist. In diesem Fall ist nur eine Antwort für „200“ (erfolgreiche Antwort) angegeben. Sie können jedoch zusätzliche Antworten festlegen.

5. Der Bereich Prüfung zeigt alle Probleme an, die in der API-Definition erkannt werden. Überprüfen Sie die Informationen in diesem Bereich, bevor Sie einen Connector speichern.

Aktualisieren Sie die Definition

Ändern Sie nun einige Einstellungen, um die Verwendung des Connectors in einer Logik-App, Power Automate oder Power Apps zu vereinfachen.

1. Aktualisieren Sie die Zusammenfassung im Bereich Allgemein auf „Gibt einen numerischen Wert für die ermittelte Stimmung zurück“.

2. Im Bereich Anforderung wählen Sie Body dann Bearbeiten.

3. Im Bereich Parameter sehen Sie nun die drei Parameter, die die API erwartet: id, language und text. Wählen Sie ID und dann Bearbeiten.

4. Aktualisieren Sie im Bereich Schemaeigenschaft Werte für den Parameter, und wählen Sie dann Zurück.

   

   Parameter	Wert
   Titel	„ID“
   Beschreibung	„Eine Kennung für jedes Dokument, das Sie einreichen“
   Standardwert	„1“
   Ist erforderlich	„Ja“

5. Klicken Sie im Bereich Parameter auf Sprache und dann auf Bearbeiten, und wiederholen Sie den Vorgang, den Sie weiter oben angewendet haben, mit den folgenden Werten.

   Parameter	Wert
   Titel	„Sprache“
   Beschreibung	„Der 2- oder 4-stellige Sprachcode für den Text“
   Standardwert	„de“
   Ist erforderlich	„Ja“

6. Klicken Sie im Bereich Parameter auf Text und dann auf Bearbeiten, und wiederholen Sie den Vorgang, den Sie weiter oben angewendet haben, mit den folgenden Werten.

   Parameter	Wert
   Titel	„Text“
   Beschreibung	„Der Text, der auf Stimmung zu analysieren ist“
   Standardwert	keine
   Ist erforderlich	„Ja“

7. Wählen Sie im Bereich Parameter die Option Zurück aus, um zurück zur Hauptseite für die Definition zu wechseln.

8. Wählen Sie oben rechts im Assistenten Konnektor aktualisieren.

Konnektor testen

Nachdem Sie den Connector erstellt haben, testen Sie ihn, um sicherzustellen, dass er ordnungsgemäß funktioniert. Tests sind nur in Power Automate und Power Apps verfügbar.

1. Wählen Sie auf der Seite Test die Option Neue Verbindung aus.

2. Geben Sie den API-Schlüssel der Text Analytics API ein und wählen Sie dann Verbindung erstellen.

3. Zurück zur Seite Testseite:

   • In Power Automate werden Sie zur Seite Test zurückgeführt. Wählen Sie das Aktualisierungssymbol, um sicherzustellen, dass die Verbindungsinformationen aktualisiert werden.
   • Unter Power Apps gelangen Sie zur Liste der in der aktuellen Umgebung verfügbaren Verbindungen. Wählen Sie in der oberen rechten Ecke das Zahnradsymbol und wählen Sie dann Benutzerdefinierte Konnektoren. Wählen Sie den Konnektor, den Sie erstellt haben, und gehen Sie dann zurück zur Seite Test.

4. Geben Sie auf der Seite Test einen Wert für das Feld Text ein (die anderen Felder verwenden die von Ihnen zuvor festgelegten Standardwerte), und wählen Sie dann Testbetrieb.

5. Der Connector ruft die API auf, und Sie können die Antwort überprüfen, die die Stimmungsbewertung enthält.

   

Einschränkungen

Wenn Sie in Power Automate und Power Apps einen vorhandenen benutzerdefinierten Connector mithilfe einer Postman-Sammlung aktualisieren, müssen Sie alle vorherigen Anpassungen wiederholen, bevor Sie den Connector speichern. Beispielsweise müssen Sie den Authentifizierungstyp und die Standardwerte der Parameter für die Aktionen neu konfigurieren.

Nächste Schritte,

Nachdem Sie einen benutzerdefinierten Verbinder erstellt und dessen Verhalten definiert haben, verwenden Sie den Verbinder.

• Einen benutzerdefinierten Connector in einem Flow verwenden
• Benutzen Sie einen benutzerdefinierten Konnektor aus einer Anwendung
• Einen benutzerdefinierten Connector aus einer Logik-App verwenden

Sie können einen Connector auch innerhalb Ihrer Organisation freigeben oder den Connector zertifiziert erhalten, damit Personen außerhalb Ihrer Organisation ihn verwenden können.

• Ihren Connector mit anderen teilen
• Ihren Connector zertifizieren

Feedback senden

Wir freuen uns sehr über Feedback zu Problemen mit unserer Connector-Plattform oder neuen Feature-Ideen. Wenn Sie Feedback geben möchten, gehen Sie zu Probleme melden oder Hilfe zu Connectors und wählen Sie einen Feedbacktyp aus.