Een aangepaste connector maken op basis van een Postman-verzameling

Notitie

Dit onderwerp maakt deel uit van een reeks zelfstudies over het maken en gebruiken van aangepaste connectors in Azure Logic Apps, Power Automate en Power Apps. Zorg ervoor dat u het overzicht van aangepaste connectors leest om het proces te begrijpen.

Als u een aangepaste connector wilt maken, beschrijft u de API waarmee u verbinding wilt maken, zodat de connector de bewerkingen en gegevensstructuren van de API begrijpt. In dit onderwerp maakt u een aangepaste connector met behulp van een Postman-verzameling die de Cognitive Services Text Analytics Sentiment-API beschrijft (ons voorbeeld voor deze serie).

Ga naar de volgende onderwerpen voor andere manieren om een API te beschrijven:

Vereisten

De Postman-verzameling importeren

U kunt nu aan de slag met de Postman-verzameling die u hebt gemaakt of gedownload. Een groot deel van de vereiste informatie is opgenomen in de verzameling. U kunt deze informatie ook bekijken en bijwerken terwijl u de wizard voor aangepaste connectors doorloopt. Begin door de Postman-verzameling voor Logic Apps of voor Power Automate en Power Apps te importeren.

De Postman-verzameling voor Logic Apps importeren

  1. Ga naar de Azure-portal en open de Logic Apps-connector die u eerder hebt gemaakt in Een aangepaste connector voor Azure Logic Apps maken.

  2. Kies in het menu van uw connector de optie Logic Apps-connector en kies vervolgens Bewerken.

    Logic Apps-connector bewerken

  3. Kies onder Algemeen de optie Postman-verzameling V1 uploaden en navigeer vervolgens naar de Postman-verzameling die u hebt gemaakt.

    Schermopname met de optie Upload Postman collection V1.

    De wizard importeert de verzameling en converteert deze vervolgens naar een OpenAPI-definitie met de naam generatedApiDefinition.swagger.json.

Notitie

Deze zelfstudie richt zich op een REST API, maar u kunt ook gebruikmaken van een SOAP API met Logic Apps.

De Postman-verzameling voor Power Automate en Power Apps importeren

  1. Ga naar make.powerapps.com of flow.microsoft.com.

  2. Selecteer Gegevens > Aangepaste connectors in het navigatiedeelvenster.

  3. Kies Nieuwe aangepaste connector en kies vervolgens Een Postman-verzameling importeren.

  4. Voer een naam in voor de aangepaste connector, navigeer vervolgens naar de Postman-verzameling die u hebt gedownload of gemaakt en kies Doorgaan.

    Schermopname met de stappen voor het importeren van de collectie.

    Parameter Waarde
    Aangepaste connectortitel "SentimentDemo"

    De wizard importeert de verzameling en converteert deze vervolgens naar een OpenAPI-definitie met de naam generatedApiDefinition.swagger.json.

Algemene details bijwerken

Vanaf dit punt laten we u de gebruikersinterface van Power Automate zien, maar de stappen zijn grotendeels hetzelfde voor alle drie de technologieën. Eventuele verschillen worden gemarkeerd.

  1. Controleer op de pagina Algemeen de gegevens die zijn geïmporteerd uit de Postman-verzameling, met inbegrip van de host en de basis-URL voor de API. De connector maakt gebruik van de host en de basis-URL om te bepalen hoe de API moet worden aangeroepen.

    Notitie

    zie voor meer informatie over het maken van verbinding met on-premises API's Verbinding maken met on-premises API's via de gegevensgateway.

  2. Wijzig de beschrijving om deze wat zinvoller te maken. Deze beschrijving wordt weergegeven in de gegevens van de aangepaste connector en maakt aan andere gebruikers duidelijk op welke manier de connector nuttig voor hen kan zijn.

    Parameter Weergegeven als
    Beschrijving "Gebruikt de Cognitive Services Text Analytics Sentiment API om te bepalen of tekst positief of negatief is"

Type verificatie opgeven

Er zijn verschillende opties voor verificatie beschikbaar in aangepaste connectors. De Cognitive Services-API's maken gebruik van API-sleutelverificatie.

  1. Kies op de pagina Beveiliging bij Verificatietype de optie API-sleutel.

  2. Geef bij API-sleutel een label, naam en locatie op voor de parameter. Kies een duidelijk en zinvol label. Deze tekst wordt weergegeven voor gebruikers zodat ze verbindingen kunnen maken met behulp van uw aangepaste connector. De naam en locatie van de parameter moeten overeenkomen met wat de API verwacht (in dit geval de header die u hebt opgegeven in Postman). Kies Verbinding maken.

    Parameters voor API-sleutel

    Parameter Weergegeven als
    Parameterlabel "API-sleutel"
    Parameternaam "Ocp-Apim-Subscription-Key"
    Parameterlocatie "Koptekst"
  3. Controleer boven aan de wizard of de naam is ingesteld op "Gevoelsdemo" en kies vervolgens Connector maken.

De definitie van de connector controleren en bijwerken

De wizard voor aangepaste connectors biedt u een groot aantal opties om te definiëren hoe de connector functioneert en hoe deze zichtbaar wordt gemaakt in logische apps, stromen en apps. We zullen de gebruikersinterface uitleggen en een paar opties in deze sectie behandelen, maar we raden u ook aan om deze zelf te verkennen.

De gebruikersinterface en definitie controleren

Voordat we ingaan op enkele specifieke stappen op de pagina Definitie gaan we eerst de gebruikersinterface bekijken.

  1. In dit gebied worden alle acties, triggers (voor Logic Apps en Power Automate) en referenties weergegeven die voor de connector zijn gedefinieerd. In dit geval wordt de actie DetectSentiment uit de Postman-verzameling weergegeven. Deze connector bevat geen triggers, maar in Een webhook gebruiken voor Azure Logic Apps en Power Automate kunt u meer leren over triggers voor aangepaste connectors.

    Pagina Definitie - acties en triggers

  2. Het gebied Algemeen bevat informatie over de actie of trigger die momenteel is geselecteerd. Deze informatie wordt opgehaald uit de Postman-verzameling. U kunt de informatie hier bewerken, met inbegrip van de eigenschap Zichtbaarheid voor bewerkingen en parameters in een logische app of stroom:

    • belangrijk: altijd eerst voor de gebruiker weergegeven
    • geen: wordt normaal weergegeven in de logische app of stroom
    • advanced: in eerste instantie verborgen in een aanvullend menu
    • internal: niet weergegeven voor de gebruiker
  3. In het gebied Aanvraag wordt informatie weergegeven op basis van de HTTP-aanvraag die is opgenomen in de Postman-verzameling. In dit geval is het HTTP-werkwoord POST en de URL "/text/analytics/v2.0/sentiment" (de volledige URL naar de API is <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment>). We gaan de parameter hoofdtekst hieronder nader bekijken.

  4. In het gebied Antwoord wordt informatie weergegeven die gebaseerd is op het HTTP-antwoord dat is opgenomen in de Postman-verzameling. In dit geval is er alleen een antwoord gedefinieerd voor '200' (een geslaagd antwoord), maar u kunt aanvullende antwoorden definiëren.

  5. In het gebied Validatie worden eventuele problemen weergegeven die zijn gedetecteerd in de API-definitie. Controleer dit gebied goed voordat u een connector opslaat.

De definitie bijwerken

Nu gaan we een aantal dingen wijzigen, zodat de connector handiger is wanneer iemand deze gebruikt in een Logic App, Power Automate of Power Apps.

  1. Werk in het gebied Algemeen het overzicht bij naar "Retourneert een numerieke score die het gedetecteerde gevoel vertegenwoordigt".

  2. Kies in het gebied Aanvraag de optie hoofdtekst en vervolgens Bewerken.

  3. In het gebied Parameter ziet u nu de drie parameters die de API verwacht: id, language en text. Kies id en vervolgens Bewerken.

  4. Werk in het gebied Schema-eigenschap waarden voor de parameter bij en kies vervolgens Vorige.

    Schema-eigenschap bewerken

    Parameter Waarde
    Titel "ID"
    Beschrijving "Een id voor elk document dat u verzendt"
    Standaardwaarde "1"
    Is vereist "Ja"
  5. In het gebied Parameter kiest u taal en Bewerken. Herhaal vervolgens het proces dat u hierboven hebt gebruikt met de volgende waarden.

    Parameter Weergegeven als
    Titel "Language"
    Beschrijving "De taalcode van 2 of 4 tekens voor de tekst"
    Standaardwaarde "en"
    Is vereist "Ja"
  6. In het gebied Parameter kiest u tekst en Bewerken. Herhaal vervolgens het proces dat u hierboven hebt gebruikt met de volgende waarden.

    Parameter Weergegeven als
    Titel "Tekst"
    Beschrijving "De tekst die moet worden geanalyseerd op gevoel"
    Standaardwaarde Geen
    Is vereist "Yes"
  7. Kies Vorige in het gebied Parameter om terug te gaan naar de hoofdpagina van de definitie.

  8. Kies rechtsboven in de wizard de optie Connector bijwerken.

De connector testen

Nu u de connector hebt gemaakt, test u deze om te controleren of de connector juist werkt. Testen is momenteel alleen beschikbaar in Power Automate en Power Apps.

Belangrijk

Als u een API-sleutel gebruikt, raden we u aan de connector niet onmiddellijk na het maken te testen. Het kan een paar minuten duren voordat de connector gereed is om verbinding te maken met de API.

  1. Kies Nieuwe verbinding op de pagina Testen.

  2. Voer de API-sleutel in vanuit de Text Analytics-API en kies vervolgens Verbinding maken.

  3. Ga terug naar de Testpagina:

    • In Power Automate wordt u teruggeleid naar de pagina Testen. Kies het pictogram Vernieuwen om ervoor te zorgen dat de verbindingsgegevens worden bijgewerkt.
    • In Power Apps wordt u naar de lijst met verbindingen geleid die beschikbaar zijn in de huidige omgeving. Kies het tandwielpictogram in de rechterbovenhoek en kies vervolgens Aangepaste connectors. Kies de connector die u hebt gemaakt en ga vervolgens terug naar de pagina Testen.
  4. Voer op de pagina Testen een waarde in het veld tekst in (de andere velden hebben de standaardwaarden die u eerder hebt ingesteld). Kies vervolgens Testbewerking.

  5. De connector roept de API aan en u kunt de respons bekijken, inclusief de gevoelsscore.

    Respons van connector

Beperkingen

Als u in Power Automate en Power Apps een bestaande aangepaste connector bijwerkt met behulp van een Postman-verzameling, moet u eerdere aanpassingen opnieuw uitvoeren voordat u de connector opslaat. U moet bijvoorbeeld het verificatietype, de standaardwaarden van de parameters voor de acties en andere zaken opnieuw configureren.

Volgende stappen

Nu u een aangepaste connector hebt gemaakt en het gedrag van deze connector hebt gedefinieerd, kunt u de connector gaan gebruiken.

U kunt een connector ook delen binnen uw organisatie en/of ervoor zorgen dat de connector wordt gecertificeerd zodat personen buiten de organisatie deze kunnen gebruiken.

Feedback geven

We stellen feedback over problemen met ons connectorplatform of ideeën voor nieuwe functies zeer op prijs. Om feedback te geven, gaat u naar Problemen melden of hulp krijgen met connectoren en selecteer uw feedbacktype.