Erstellen eines benutzerdefinierten Connectors ohne VorlageCreate a custom connector from scratch

Hinweis

Dieses Thema ist Teil einer Tutorialreihe zum Erstellen und Verwenden von benutzerdefinierten Connectors in Azure Logic Apps, Microsoft Flow und PowerApps.This topic is part of a tutorial series on creating and using custom connectors in Azure Logic Apps, Microsoft Flow, and PowerApps. Lesen Sie unbedingt zuerst die Informationen unter Custom connectors overview (Überblick über benutzerdefinierte Connectors).Make sure you read the custom connector overview to understand the process.

Zur Erstellung eines benutzerdefinierten Connectors müssen Sie die API beschreiben, mit der eine Verbindung hergestellt werden soll, sodass der Connector die API-Vorgänge und -Datenstrukturen nachvollziehen kann.To create a custom connector, you must describe the API you want to connect to so that the connector understands the API's operations and data structures. In diesem Thema erstellen Sie einen benutzerdefinierten Connector ohne Vorlage und ohne Postman-Sammlung oder OpenAPI-Definition, die die Stimmungs-API der Cognitive Services-Textanalyse (unser Beispiel für diese Serie) beschreibt.In this topic, you create a custom connector from scratch, without using a Postman collection or an OpenAPI definition to describe the Cognitive Services Text Analytics Sentiment API (our example for this series). Stattdessen beschreiben Sie den Connector vollständig im Assistenten für benutzerdefinierte Connectors.Instead, you describe the connector completely in the custom connector wizard.

Andere Möglichkeiten zum Beschreiben einer API finden Sie in den folgenden Themen:For other ways to describe an API, see the following topics:

Hinweis

In Microsoft Flow und PowerApps können Sie derzeit einen benutzerdefinierten Connector ohne Vorlage erstellen.You can currently create a custom connector from scratch in Microsoft Flow and PowerApps. Bei Logic Apps müssen Sie zumindest mit einer grundlegenden OpenAPI-Definition oder Postman-Sammlung beginnen.For Logic Apps, you must start with at least a basic OpenAPI definition or Postman collection.

VoraussetzungenPrerequisites

Starten des Assistenten für benutzerdefinierte ConnectorsStart the custom connector wizard

  1. Navigieren Sie zu web.powerapps.com oder flow.microsoft.com.Go to powerapps.com or flow.microsoft.com.

  2. Klicken Sie in der Ecke oben rechts auf das Zahnradsymbol und dann auf Benutzerdefinierte Connectors.In the upper right corner, choose the gear icon, then choose Custom connectors.

    Zahnradsymbol im Dienst

  3. Klicken Sie auf Benutzerdefinierten Connector erstellen und dann auf Ohne Vorlage erstellen.Choose Create custom connector, then choose Create from blank.

    Erstellen eines benutzerdefinierten Connectors

  4. Geben Sie einen Namen für den benutzerdefinierten Connector ein, und klicken Sie dann auf Verbinden.Enter a name for the custom connector, then choose Connect.

    Hochladen der Postman-Sammlung

    ParameterParameter WertValue
    Titel des benutzerdefinierten ConnectorsCustom connector title „SentimentDemo“"SentimentDemo"

Aktualisieren allgemeiner InformationenUpdate general details

Ab hier sehen Sie die Benutzeroberfläche von Microsoft Flow. Die Schritte stimmen in allen Technologien aber größtenteils überein.From this point, we'll show the Microsoft Flow UI, but the steps are largely the same across the technologies. Auf Unterschiede wird hingewiesen.We'll point out any differences.

  1. Auf der Seite Allgemein:On the General page:

    • Geben Sie einen aussagekräftigen Wert für Beschreibung ein.Enter a meaningful value for Description. Anhand dieser Beschreibung, die in den Details des benutzerdefinierten Connectors angezeigt wird, können Benutzer ermitteln, ob der Connector für sie von Nutzen ist.This description is displayed in the custom connector's details, and it can help others know if the connector could be useful to them.

    • Ändern Sie Host in die Adresse für die Textanalyse-API.Update Host to the address for the Text Analytics API. Der Connector verwendet den API-Host und die Basis-URL, um zu bestimmen, wie die API aufgerufen wird.The connector uses the API host and the base URL to determine how to call the API.

    Seite „Allgemein“ des benutzerdefinierten Connectors

    ParameterParameter WertValue
    BeschreibungDescription „Verwendet die Stimmungs-API der Cognitive Services-Textanalyse, um zu ermitteln, ob Text positiv oder negativ ist.“"Uses the Cognitive Services Text Analytics Sentiment API to determine whether text is positive or negative"
    HostHost „westus.api.cognitive.microsoft.com“"westus.api.cognitive.microsoft.com"

    Hinweis

    Weitere Informationen zur Option Über lokales Datengateway verbinden finden Sie unter Connect to custom on-premises APIs using data gateway (Herstellen einer Verbindung mit benutzerdefinierten lokalen APIs mithilfe eines Datengateways).For more information about the option Connect via on-premises data gateway, see Connect to on-premises APIs using the data gateway.

Angeben des AuthentifizierungstypsSpecify authentication type

In benutzerdefinierten Connectors stehen verschiedene Optionen für die Authentifizierung zur Verfügung.There are several options available for authentication in custom connectors. Die Cognitive Services-APIs verwenden die API-Schlüsselauthentifizierung. Sie geben für dieses Tutorial also diese Authentifizierungsoption an.The Cognitive Services APIs use API key authentication, so that's what you specify for this tutorial.

  1. Wählen Sie auf der Seite Sicherheit unter Authentifizierungstyp die Option API-Schlüssel aus.On the Security page, under Authentication type, choose API Key.

    Authentifizierungsart

  2. Geben Sie unter API-Schlüssel eine Bezeichnung, einen Namen und einen Ort für den Parameter an.Under API Key, specify a parameter label, name, and location. Geben Sie eine aussagekräftige Bezeichnung an, da diese angezeigt wird, wenn ein Benutzer zum ersten Mal eine Verbindung mit dem benutzerdefinierten Connector herstellt.Specify a meaningful label, because this is displayed when someone first makes a connection with the custom connector. Der Parametername und der Ort müssen mit den von der API erwarteten Werten übereinstimmen.The parameter name and location must match what the API expects. Klicken Sie auf Verbinden.Choose Connect.

    Parameter des API-Schlüssels

    ParameterParameter WertValue
    ParameterbezeichnungParameter label „API-Schlüssel“"API key"
    ParameternameParameter name „Ocp-Apim-Subscription-Key“"Ocp-Apim-Subscription-Key"
    Parameter location (Ort des Parameters)Parameter location „Header“"Header"
  3. Stellen Sie oben im Assistenten sicher, dass als Name „SentimentDemo“ festgelegt ist. Klicken Sie dann auf Connectorerstellung.At the top of the wizard, make sure the name is set to "SentimentDemo", then choose Create connector.

Erstellen der ConnectordefinitionCreate the connector definition

Im Assistenten für benutzerdefinierte Connectors stehen zahlreiche Optionen zur Verfügung, mit denen Sie festlegen können, wie der Connector funktioniert und wie er in Logik-Apps, Flows und Apps verfügbar gemacht wird.The custom connector wizard gives you a lot of options for defining how your connector functions, and how it is exposed in logic apps, flows, and apps. In diesem Abschnitt werden zwar die Benutzeroberfläche und einige Optionen vorgestellt, es wird jedoch empfohlen, sich auch auf eigene Faust damit auseinanderzusetzen.We'll explain the UI and cover a few options in this section, but we also encourage you to explore on your own.

Erstellen einer AppCreate an action

Erstellen Sie als Erstes eine Aktion, die die Stimmungs-API der Textanalyse aufruft.The first thing to do is create an action that calls the Text Analytics Sentiment API.

  1. Auf der Seite Definition werden im linken Bereich alle Aktionen, Trigger (für Logic Apps und Microsoft Flow) und Verweise angezeigt, die für den Connector definiert sind.On the Definition page, the left area displays any actions, triggers (for Logic Apps and Microsoft Flow), and references that are defined for the connector. Klicken Sie auf Neue Aktion.Choose New action.

    Definitionsseite – Aktionen und Trigger

    Dieser Connector enthält keine Trigger. Unter Use a webhook as a trigger for Azure Logic Apps and Microsoft Flow (Verwenden eines Webhooks als Trigger für Azure Logic Apps und Microsoft Flow) finden Sie jedoch Informationen zu Triggern für benutzerdefinierte Connectors.There are no triggers in this connector, but you can learn about triggers for custom connectors in Use webhooks with Azure Logic Apps and Microsoft Flow.

  2. Der Bereich Allgemein enthält Informationen zur derzeit ausgewählten Aktion bzw. zum derzeit ausgewählten Trigger.The General area displays information about the action or trigger currently selected. Fügen Sie eine Zusammenfassung, eine Beschreibung und die Vorgangs-ID für diese Aktion hinzu.Add a summary, description, and operation ID for this action.

    Definitionsseite – Allgemein

    ParameterParameter WertValue
    ZusammenfassungSummary „Gibt einen numerischen Wert für die ermittelte Stimmung zurück“"Returns a numeric score representing the sentiment detected"
    BeschreibungDescription „Die API gibt einen numerischen Wert zwischen 0 und 1 zurück."The API returns a numeric score between 0 and 1. Werte nahe 1 weisen auf eine positive Stimmung hin, Werte nahe 0 weisen auf eine negative Stimmung hin.“Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment."
    Vorgangs-IDOperation ID „DetectSentiment“"DetectSentiment"

    Übernehmen Sie für die Eigenschaft Sichtbarkeit den Wert keine.Leave the Visibility property set to none. Für diese Eigenschaft für Vorgänge und Parameter in einer Logik-App oder einem Flow stehen folgende Optionen zur Verfügung:This property for operations and parameters in a logic app or flow has the following options:

    • keine: normale Anzeige in der Logik-App oder im Flownone: displayed normally in the logic app or flow
    • erweitert: in einem zusätzlichen Menü verstecktadvanced: hidden under an additional menu
    • intern: für den Benutzer ausgeblendetinternal: hidden from the user
    • wichtig:immer zuerst für den Benutzer angezeigtimportant: always shown to the user first
  3. Der Bereich Anforderung enthält Informationen, die auf der HTTP-Anforderung für die Aktion basieren.The Request area displays information based on the HTTP request for the action. Klicken Sie auf Aus Beispiel importieren.Choose Import from sample.

    Definitionsseite – Aus Beispiel importieren

  4. Geben Sie die Informationen, die zum Herstellen einer Verbindung mit der API erforderlich sind, und den Anforderungstext an, und klicken Sie dann auf Importieren.Specify the information necessary to connect to the API, and the request body, then choose Import. Diese Informationen werden für Sie bereitgestellt (unterhalb der Abbildung).We provide this information for you (below the image). Bei einer öffentlichen API, etwa der Stimmungs-API für die Textanalyse, finden Sie sie in der Regel in der Dokumentation.For a public API, you typically get it from the documentation, like Text Analytics Sentiment API.

    Definitionsseite – Aus Beispiel importieren

    ParameterParameter WertValue
    VerbVerb „POST“"POST"
    URLURL "https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment""https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment"
    TextBody Siehe untenSee below
    {
      "documents": [
        {
          "language": "string",
          "id": "string",
          "text": "string"
        }
      ]
    }
    
  5. Der Bereich Antwort enthält Informationen, die auf der HTTP-Antwort für die Aktion basieren.The Response area displays information based on the HTTP response for the action. Wählen Sie Standardantwort hinzufügen.Choose Add default response.

    Definitionsseite – Antwort

  6. Geben Sie den Antworttext ein, und klicken Sie dann auf Importieren.Specify the response body, then choose Import. Wie bei der Anforderung werden diese Informationen von uns bereitgestellt, sie befinden sich aber in der Regel in der API-Dokumentation.Like the request, we provide this information for you, but it's typically in the API documentation.

    Definitionsseite – Antwort

    {
     "documents": [
       {
         "score": 0.0,
         "id": "string"
       }
     ],
     "errors": [
       {
         "id": "string",
         "message": "string"
       }
     ]
    }
    
  7. Im Bereich Überprüfung werden Fehler in der API-Definition angezeigt.The Validation area displays any issues that are detected in the API definition. Überprüfen Sie den Status, und klicken Sie dann oben rechts im Assistenten auf Connector aktualisieren.Check the status, then at the top right of the wizard, choose Update connector.

    Definitionseite – Überprüfung

Aktualisieren der DefinitionUpdate the definition

Wir ändern nun ein paar Angaben, sodass der Connector in einer Logik-App, einem Flow oder einer PowerApps-App einfacher zu verwenden ist.Now let's change a few things so that the connector is more friendly when someones uses it in a logic app, flow, or PowerApps app.

  1. Klicken Sie im Bereich Anforderung auf Text und dann auf Bearbeiten.In the Request area, choose body then Edit.

    Bearbeiten des Anforderungstexts

  2. Im Bereich Parameter werden nun die von der API erwarteten drei Parameter angezeigt: id, language und text.In the Parameter area, you now see the three parameters that the API expects: id, language, and text. Klicken Sie auf ID und dann auf Bearbeiten.Choose id then Edit.

    Bearbeiten von „ID“ des Anforderungstexts

  3. Aktualisieren Sie im Bereich Schemaeigenschaft die Werte für den Parameter, und klicken Sie dann auf Zurück.In the Schema Property area, update values for the parameter, then choose Back.

    Bearbeiten der Schemaeigenschaft

    ParameterParameter WertValue
    TitelTitle „ID“"ID"
    BeschreibungDescription „Ein Bezeichner für jedes übermittelte Dokument“"An identifier for each document that you submit"
    StandardwertDefault value „1“"1"
    Ist erforderlichIs required „Ja“"Yes"
  4. Klicken Sie im Bereich Parameter auf Sprache und dann auf Bearbeiten, und wiederholen Sie den Vorgang für id. Verwenden Sie dabei die folgenden Werte:In the Parameter area, choose language then Edit, and repeat the process you used for id, with the following values.

    ParameterParameter WertValue
    TitelTitle „Sprache“"Language"
    BeschreibungDescription „Der zwei- oder vierstellige Sprachcode für den Text“"The 2 or 4 character language code for the text"
    StandardwertDefault value „de“"en"
    Ist erforderlichIs required „Ja“"Yes"
  5. Klicken Sie im Bereich Parameter auf Text und dann auf Bearbeiten, und wiederholen Sie die Schritte, die Sie auch für id und language ausgeführt haben. Verwenden Sie dabei die folgenden Werte:In the Parameter area, choose text then Edit, and repeat the process you used for id and language, with the following values.

    ParameterParameter WertValue
    TitelTitle „Text“"Text"
    BeschreibungDescription „Der Text für die Stimmungsanalyse“"The text to analyze for sentiment"
    StandardwertDefault value KeineNone
    Ist erforderlichIs required „Ja“"Yes"
  6. Klicken Sie im Bereich Parameter auf Zurück, um zurück auf die Hauptseite für die Definition zu wechseln.In the Parameter area, choose Back to take you back to the main definition page.

  7. Klicken Sie oben rechts im Assistenten auf Connector aktualisieren.At the top right of the wizard, choose Update connector.

Testen des ConnectorsTest the connector

Sie haben den Connector erstellt und sollten nun testen, ob er ordnungsgemäß funktioniert.Now that you've created the connector, test it to make sure it's working properly. Die Testfunktion steht derzeit nur in Microsoft Flow und PowerApps zur Verfügung.Testing is currently available only in Microsoft Flow and PowerApps.

Wichtig

Bei Verwendung eines API-Schlüssels sollten Sie den Connector nicht direkt nach seiner Erstellung testen.When using an API key, we recommend not testing the connector immediately after you create it. Es dauert einige Minuten, bis der Connector mit der API verbunden werden kann.It can take a few minutes until the connector is ready to connect to the API.

  1. Klicken Sie auf der Seite Test auf Neue Verbindung.On the Test page, choose New connection.

    Neue Verbindung

  2. Geben Sie den API-Schlüssel aus der Textanalyse-API ein, und klicken Sie dann auf Verbindung erstellen.Enter the API key from the Text Analytics API, then choose Create connection.

    Erstellen der Verbindung

  3. Kehren Sie zurück zur Testseite:Return to the Test page:

    • In Microsoft Flow werden Sie zurück zur Seite Test geleitet.In Microsoft Flow, you are taken back to the Test page. Klicken Sie auf das Aktualisierungssymbol, um sicherzustellen, dass die Verbindungsinformationen aktualisiert werden.Choose the refresh icon to make sure the connection information is updated.

      Aktualisieren der Verbindung

    • In PowerApps werden Sie zur Liste der Verbindungen weitergeleitet, die in der aktuellen Umgebung verfügbar sind.In PowerApps, you are taken to the list of connections available in the current environment. Klicken Sie in der Ecke oben rechts auf das Zahnradsymbol und dann auf Benutzerdefinierte Connectors.In the upper right corner, choose the gear icon, then choose Custom connectors. Wählen Sie den von Ihnen erstellen Connector aus, und wechseln Sie dann zurück zur Seite Test.Choose the connector you created, then go back to the Test page.

      Zahnradsymbol im Dienst

  4. Geben Sie auf der Seite Test einen Wert für das Feld Text ein (die anderen Felder enthalten die von Ihnen zuvor festgelegten Standardwerte), und klicken Sie auf Vorgang testen.On the Test page, enter a value for the text field (the other fields use the defaults that you set earlier), then choose Test operation.

    Vorgang testen

  5. Der Connector ruft die API auf, und Sie können die Antwort mit dem Stimmungswert überprüfen.The connector calls the API, and you can review the response, which includes the sentiment score.

    Connectorantwort

Nächste SchritteNext steps

Sie haben einen benutzerdefinierten Connector erstellt und sein Verhalten definiert. Nun können Sie den Connector verwenden:Now that you've created a custom connector and defined its behaviors, you can use the connector:

Sie können einen Connector auch innerhalb Ihrer Organisation freigeben und/oder den Connector zertifizieren lassen, sodass er von Personen außerhalb Ihrer Organisation verwendet werden kann:You can also share a connector within your organization and/or get the connector certified so that people outside your organization can use it: