Opret en brugerdefineret connector fra en Postman-samling

Bemærk

Dette emne er en del af en serie af selvstudier om oprettelse og anvendelse af brugerdefinerede connectorer i Azure Logic Apps, Power Automate og Power Apps. Sørg for at læse oversigten over brugerdefinerede connectorer for at forstå processen.

Når du skal oprette en brugerdefineret connector, skal du beskrive den API, du vil oprette forbindelse til, så connectoren forstår API'ens handlinger og datastrukturer. I dette emne skal du oprette en brugerdefineret connector ved hjælp af en Postman-samling til at beskrive Cognitive Services-API'en til tekstanalyse (eksemplet for denne serie).

Du kan finde andre måder at beskrive en API på i følgende emner:

Forudsætninger

Importere Postman collection

Du er nu klar til at arbejde med den Postman-samling, du oprettede eller downloadede. En stor del af de påkrævede oplysninger er inkluderet i samlingen. Du kan også gennemse og opdatere disse oplysninger, når du gennemgår guiden til brugerdefinerede connectorer. Start med at importere Postman-samlingen for Logic Apps eller Power Automate og Power Apps.

Importér Postman-samlingen for Logic Apps

  1. Gå til Azure-portalen, og åbn den Logic Apps-connector, du oprettede tidligere i Opret en brugerdefineret Azure Logic Apps-connector.

  2. Vælg Logic Apps Connector i connectorens menu, og vælg derefter Rediger.

    Rediger Logic Apps-connector

  3. Vælg Upload Postman Collection V1 under Generelt, og naviger derefter til den Postman-samling, du har oprettet.

    Upload Postman-samling

    Guiden importerer samlingen og konverterer den til en OpenAPI-definition med navnet generatedApiDefinition.swagger.json.

Bemærk

Dette selvstudium fokuserer på en REST-API, men du kan også bruge en SOAP-API med Logic Apps.

Importér Postman-samlingen for Power Automate og Power Apps

  1. Gå til make.powerapps.com eller flow.microsoft.com.

  2. I navigationsruden skal du vælge Data > Brugerdefinerede connectors.

    Vælg brugerdefineret connector

  3. Vælg Ny brugerdefineret connector, og vælg derefter Importér en Postman Collection.

    Importér en Postman Collection

  4. Angiv et navn til den brugerdefinerede connector, og gå derefter til den Postman-samling, du har downloadet eller oprettet, og vælg Fortsæt.

    Upload Postman-samling

    Parameter Værdi
    Titel på brugerdefineret forbindelse "SentimentDemo"

    Guiden importerer samlingen og konverterer den til en OpenAPI-definition med navnet generatedApiDefinition.swagger.json.

Opdater de generelle oplysninger

Fra nu af vises brugergrænsefladen i Power Automate, men trinnene er stort set de samme i alle tre teknologier. Alle forskelle fremhæves.

  1. På siden Generelt skal du gennemse oplysningerne, der blev importeret fra Postman collection, herunder værten og den grundlæggende URL-adresse for API'en. Connectoren bruger værten og den grundlæggende URL-adresse til at klarlægge, hvordan API'en skal kaldes.

    Siden Generelt til brugerdefineret connector

    Bemærk

    Du kan finde flere oplysninger om forbindelsen til lokale API'er under Oprette forbindelse til lokale API'er ved hjælp af datagateway.

  2. Opdater beskrivelsen til noget, der giver mening. Denne beskrivelse vises i oplysningerne om den brugerdefinerede connector, og den kan hjælpe andre brugere med at forstå, hvordan connectoren kan være nyttig for dem.

    Parameter Værdi
    Beskrivelse "Bruger Cognitive Services-API'en til tekstanalyse til at registrere, om teksten er positiv eller negativ"

Angiv godkendelsestype

Der er flere tilgængelige indstillinger for godkendelse i brugerdefinerede connectorer. Cognitive Services-API'er bruger API-nøglegodkendelse.

  1. På siden Sikkerhed under Godkendelsestype skal du vælge API-nøgle.

    Godkendelsestype

  2. Angiv en parameteretiket, et navn og en placering under API-nøgle. Vælg et udtryksfuldt og sigende navn. Denne tekst vises for brugerne som en vejledning i, hvordan de opretter forbindelser ved hjælp af deres brugerdefinerede connector. Parameterens navn og placering skal stemme overens med, hvad API'en forventer (i dette tilfælde den header, du har angivet i Postman). Vælg Forbind.

    API-nøgleparametre

    Parameter Værdi
    Parameteretiket "API-nøgle"
    Parameternavn "Ocp-Apim-Subscription-Key"
    Parameterplacering "Overskrift"
  3. Sørg for, at navnet er angivet til "SentimentDemo" øverst i guiden, og vælg derefter Opret connector.

Gennemse og opdatere definitionen af connectoren

Guiden til brugerdefinerede connectorer giver dig mange valgmuligheder i forhold til at definere, hvordan din connector fungerer, og hvordan den vises i logikapps, flows og apps. Vi forklarer brugergrænsefladen og dækker et par muligheder i dette afsnit, men vi opfordrer dig også til at udforske på egen hånd.

Gennemse brugergrænsefladen og definitionen

Før vi går ind i nogle specifikke trin på Definition-siden, skal vi først tage et kig på brugergrænsefladen.

  1. Alle handlinger, udløsere (for Logic Apps og Power Automate) og referencer, der er defineret for connectoren, vises i dette område. I dette tilfælde vises handlingen DetectSentiment fra Postman-samlingen. Der er ingen udløsere i denne connector, men du kan få mere at vide om udløsere for brugerdefinerede connectorer under Bruge webhooks med Azure Logic Apps og Power Automate.

    Definitionsside - handlinger og udløsere

  2. I området Generelt vises oplysninger om den handling eller udløser, der er valgt i øjeblikket. Disse oplysninger kommer fra Postman collection. Du kan redigere oplysningerne her, herunder egenskaben Synlighed for handlinger og parametre i en logikapp eller et flow:

    • vigtigt: vises altid først for brugeren

    • ingen: vises normalt i logikappen eller flowet

    • avanceret: indledningsvist skjult under en ekstra menu

    • intern: vises ikke for brugeren

      Definitionsside – generelt

  3. I området Anmodning vises oplysninger baseret på HTTP-anmodningen, der er inkluderet i Postman-samlingen. I dette tilfælde er HTTP verbet lig med POST, og URL-adressen er "/text/analytics/v2.0/sentiment" (den fulde URL-adresse til API'en er "https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment"). Vi ser nærmere på brødtekst-parameteren om lidt.

    Definitionsside – anmodning

  4. I området Svar vises oplysninger, der er baseret på HTTP-svaret, som er inkluderet i Postman-samlingen. I dette tilfælde er der kun defineret et svar for "200" (et vellykket svar), men du kan angive yderligere svar.

    Definitionsside – svar

  5. I området Validering vises eventuelle problemer, der er fundet i API-definitionen. Sørg for at kontrollere dette område, før du gemmer en connector.

    Definitionsside – validering

Opdater definitionen

Lad os nu ændre et par ting, så connectoren er mere brugervenlig, når nogen bruger den i en logikapp, Power Automate eller Power Apps.

  1. I området Generelt skal du opdatere oversigten til "Returnerer en numerisk score, der repræsenterer det registrerede synspunkt".

  2. I området Anmodning skal du vælge brødtekst og derefter Rediger.

    Rediger brødtekst i anmodning

  3. I området Parameter kan du nu se de tre parametre, som API'en forventer: id, language og text. Vælg id og derefter Rediger.

    Rediger brødtekst-id i anmodning

  4. I området Skemaegenskab skal du opdatere værdier af parameteren og derefter vælge Tilbage.

    Rediger skemaegenskab'

    Parameter Værdi
    Titel "ID"
    Beskrivelse "En identifikator for hvert indsendt dokument"
    Standardværdi "1"
    Er påkrævet "Ja"
  5. I området Parameter skal du vælge sprog og derefter Rediger og gentage processen, som du brugte ovenfor, med følgende værdier.

    Parameter Værdi
    Titel "Sprog"
    Beskrivelse "Tekstens sprogkode på to eller fire tegn"
    Standardværdi "en"
    Er påkrævet "Ja"
  6. I området Parameter skal du vælge tekst og derefter Rediger og gentage processen, som du brugte ovenfor, med følgende værdier.

    Parameter Værdi
    Titel "Tekst"
    Beskrivelse "Den tekst, der skal analyseres for synspunkt"
    Standardværdi Intet
    Er påkrævet "Ja"
  7. I området Parameter skal du vælge Tilbage for at gå tilbage til den primære definitionsside.

  8. Vælg Opdater connector øverst til højre i guiden.

Test connectoren

Nu, hvor du har oprettet connectoren, kan du teste den for at sikre dig, at den fungerer korrekt. Test er i øjeblikket kun tilgængelig i Power Automate og Power Apps.

Vigtigt

Når du bruger en API-nøgle, anbefaler vi, at du ikke tester connectoren umiddelbart efter, at du har oprettet den. Det kan tage et par minutter, før connectoren er klar til at oprette forbindelse til API'en.

  1. På siden Test skal du vælge Ny forbindelse.

    Ny forbindelse

  2. Angiv API-nøglen fra API'en til Tekstanalyse, og vælg derefter Opret forbindelse.

    Opret forbindelse

  3. Gå tilbage til siden Test:

    • I Power Automate bliver du ført tilbage til siden Test. Vælg opdateringsikonet for at sikre, at forbindelsesoplysningerne er opdateret.

      Opdater forbindelse

    • I Power Apps bliver du ført til listen over tilgængelige forbindelser i det aktuelle miljø. Vælg tandhjulsikonet i øverste højre hjørne, og vælg derefter Brugerdefinerede connectorer. Vælg den connector, som du oprettede, og gå derefter tilbage til siden Test.

      Tandhjulsikon i service

  4. På siden Test skal du angive en værdi for feltet tekst (de andre felter bruger de standarder, du tidligere har angivet), og vælg derefter Test handling.

    Test handling

  5. Connectorn kalder API'en, og du kan gennemgå svaret, som omfatter synspunktsscoren.

    Connectorsvar

Næste trin

Nu, hvor du har oprettet en brugerdefineret connector og defineret dens funktionsmåde, kan du bruge connectoren:

Du kan også dele en connector i din organisation og/eller få connectoren certificeret, så folk uden for din organisation kan bruge den: