Skapa ett anpassat anslutningsprogram från en Postman-samling

  • Artikel

Anteckning

Detta ämne ingår i självstudier kring hur man skapar och använder anpassade anslutningsprogram i Azure Logic Apps, Power Automate och Power Apps. Se till att du läser översikt för anpassat anslutningsprogram för att förstå processen.

Om du vill skapa en anpassad koppling måste du beskriva det API du vill ansluta så att kopplingen förstår API:ets åtgärder och datastrukturer. I detta ämne skapar du ett anpassat anslutningsprogram med hjälp av en Postman-samling som beskriver sentiment-API för textanalys för Cognitive Services (vårt exempel för denna serie).

Gå till följande ämnen för fler sätt att beskriva ett API:

Förutsättningar

Importera en Postman-samling

Nu är du redo att arbeta med Postman-samlingen du har skapat eller laddat ned. Mycket av den information som krävs finns i samlingen. Du kan också granska och uppdatera informationen när du går igenom guiden för anpassad anslutning. Börja med att importera Postman-samling för Logic Apps eller för Power Automate och Power Apps.

Importera Postman-samling för Logic Apps

  1. Gå till Azure-portalen och öppna Logic Apps-anslutningen du skapade tidigare i Skapa en anpassad koppling för Azure Logic Apps.

  2. I din kopplingsmeny, välj Logic Apps-koppling och sedan Redigera.

    Redigera Logic Apps-koppling

  3. Under allmänt väljer du Ladda upp Postman-samling V1 och navigerar sedan till Postman-samling som du skapade.

    Skärmbild som visar alternativet Ladda upp Postman-samling V1.

    Guiden importerar samlingen och konverterar den sedan till en OpenAPI-definition kallad generatedApiDefinition.swagger.json.

Anteckning

Dessa självstudier fokuserar på ett REST-API, men du kan även använda ett SOAP-API med Logic Apps.

Importera Postman-samling för Power Automate eller Power Apps

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

  2. I navigeringsfönstret väljer du Data > Anpassade anslutningsprogram.

  3. Välj Nytt anpassat anslutningsprogram och välj sedan Importera en Postman-samling.

  4. Ange ett namn på den anpassade kopplingen och gå sedan till den Postman-samling du hämtade eller skapade och välj Fortsätt.

    Skärmbild med instruktioner för hur du importera en samling.

    Parameter Värde
    Rubrik för anpassad anslutningsapp "SentimentDemo"

    Guiden importerar samlingen och konverterar den sedan till en OpenAPI-definition kallad generatedApiDefinition.swagger.json.

Uppdatera allmän information

Från och med nu kommer vi att visa Power Automate-gränssnittet,men stegen är i stort sett samma i alla tre teknologier. Vi kommer att ange eventuella skillnader.

  1. På sidan Allmänt granskar du informationen som har importerats från Postman-samlingen, inklusive värden och den grundläggande URL:en för API:et. Anslutningen använder värden och den grundläggande URL:en för att fastställa hur API:et ska anropas.

    Anteckning

    Mer information om att ansluta till lokala API:er finns i Anslut till lokala API:er via datagatewayen.

  2. Uppdatera beskrivningen till något meningsfullt. Den här beskrivningen visas i den anpassade anslutningsappens information och den kan hjälpa andra användare att veta om anslutningsappen kan vara användbar för dem.

    Parameter Värde
    Beskrivning Använder API:et för attitydstextanalys i Cognitive Services för att fastställa om texten är positiv eller negativ.

Ange autentiseringstyp.

Det finns flera tillgängliga alternativ för autentisering i anpassade anslutningsprogram. API:er för Cognitive Services använder API-nyckelautentisering.

  1. På sidan Säkerhet, under Autentiseringstyp väljer du API-nyckel.

  2. Ange ett parameteretikett, namn och plats under API-nyckel. Välj en lättfattlig och meningsfull etikett. Den här texten visas för användare för att dirigera dem vid anslutningar som görs med hjälp av din anpassade anslutningsapp. Parameternamnet och platsen måste matcha vad API:et förväntar sig (i det här fallet rubriken du angav i Postman). Välj Anslut.

    API-nyckelparametrar

    Parameter Värde
    Parameteretikett "API-nyckel"
    Parameternamn "Ocp-Apim-Subscription-Key"
    Parameterplats "Rubrik"

  3. Längst upp i guiden, kontrollera att namnet är inställt på "SentimentDemo", välj sedan Skapa anslutning.

Granska och uppdatera definitionen för anslutningsprogrammet

Sidan för anpassade kopplingar har du många alternativ för att definiera funktioner för kopplingar och hur de exponeras i Logic Apps, flöden och appar. Vi förklarar användargränssnittet och täcker några alternativ i det här avsnittet, men vi uppmanar dig också att utforska på egen hand.

Granska användargränssnittet och definitionen

Innan vi kommer in i några specifika steg på sidan definition kan du börja med att ta en titt på användargränssnittet.

  1. Detta område visar eventuella åtgärder, utlösare (för Logic Apps och Power Automate) och referenser som har definierats för kopplingen. I det här fallet visas åtgärden DetectSentiment från Postman-samlingen. Det finns inga utlösare i den här kopplingen, men du kan lära dig om utlösare för anpassade kopplingar i avsnittet använda webhooks med Azure Logic Apps och Power Automate.

    Definitionssida – åtgärder och utlösare

  2. I området Allmänt visas information om den markerade åtgärden eller utlösaren. Den här informationen kommer från Postman-samlingen. Du kan redigera informationen här, inklusive egenskapen för synlighet för åtgärder och parametrar i en logikapp eller ett flöde:

    • viktigt: visas alltid först för användaren.
    • inget: visas normalt i logikappen eller flödet.
    • avancerat: initialt dolt under ytterligare en meny
    • internt: visas inte för användaren

  3. Området Begäran visar information baserat på en HTTP-begäran som ingår i Postman-samlingen. I detta fall ser du att verbet för HTTP är POST och att URL:en är "/text/analytics/v2.0/sentiment" (den kompletta URL:en är <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment>). Vi kommer strax att titta närmare på parametern brödtext.

  4. Området Svar visar information baserat på ett HTTP-svar som ingår i Postman-samlingen. I detta fall har det enda svaret definierats för "200" (ett framgångsrikt svar), men du kan definiera ytterligare svar.

  5. Området Validering visar de eventuella problem som upptäckts i API-definitionen. Se till att kontrollera detta område innan du sparar ett anslutningsprogram.

Uppdatera definitionen

Låt oss nu ändra några saker så att anslutningsprogrammet blir mer användarvänligt när det används i en logikapp, Power Automate eller Power Apps.

  1. I området Allmänt uppdaterar du sammanfattningen till "Returnerar en numerisk poäng som representerar det sentiment som hittats".

  2. Välj brödtext i området Begäran och välj sedan Redigera.

  3. I området Parameter ser du nu de tre parametrarna som förväntas av API:et: id, language och text. Välj ID och sedan Redigera.

  4. Gå till området Schemaegenskap, uppdatera värden för parametern och välj sedan Tillbaka.

    Redigera schemaegenskapen

    Parameter Värde
    Rubrik "ID"
    Beskrivning ”En identifierare för varje dokument som du skickar”.
    Standardvärde "1"
    Obligatoriskt "Ja"

  5. I området Parameter väljer du språk och sedan Redigera. Upprepa processen som du använde ovan med följande värden.

    Parameter Värde
    Rubrik "Språk"
    Beskrivning ”Språkkoden med 2 eller 4 tecken för texten”.
    Standardvärde "en"
    Obligatoriskt "Ja"

  6. I området Parameter väljer du text och sedan Redigera. Upprepa processen som du använde ovan med följande värden.

    Parameter Värde
    Rubrik "Text"
    Beskrivning ”Text att analysera för attityd”.
    Standardvärde Nej
    Obligatoriskt "Ja"

  7. I området Parameter, välj Tillbaka för att gå tillbaka till huvudsidan för definitionen.

  8. Välj Uppdatera kopplingen längst upp i guiden.

Testa anslutningsprogrammet

Nu när du har skapat kopplingen kan du testa den och kontrollera att den fungerar. Testning är för närvarande endast tillgänglig i Power Automate och Power Apps.

Viktigt

När du använder ett API-nyckel rekommenderar vi att du inte testar anslutningsprogrammet direkt efter att du har skapat den. Det kan ta några minuter tills anslutningen är klar att ansluta till API.

  1. Välj Ny anslutning på sidan Test.

  2. Ange API-nyckeln från API: et för textanalys och välj sedan Skapa anslutning.

  3. Gå tillbaka till testsidan:

    • I Power Automate återgår du till sidan Test. Välj uppdateringsikonen för att kontrollera att anslutningsinformationen är uppdaterad.
    • I Power Apps kommer du till listan över anslutningar som är tillgängliga i den aktuella miljön. Välj kugghjulsikonen i det övre högra hörnet och välj sedan Anpassade anslutningsprogram. Välj anslutningsprogrammet som du skapade och gå sedan tillbaka till sidan Test.

  4. På sidan Test, ange ett värde för fältet text (i de andra fälten används de standardvärden du angav tidigare) och välj sedan Teståtgärd.

  5. Anslutningsprogrammet anropar API och du kan granska svaret, vilket inkluderar sentimentpoäng.

    Svar från anslutningsprogram

Begränsningar

Om du uppdaterar en befintlig anpassad anslutning med hjälp av en Postman-samling i Power Automate och Power Apps måste du göra om alla tidigare anpassningar innan du sparar anslutningen. Du måste till exempel konfigurera om autentiseringstyp, standardvärden för parametrarna för åtgärderna och andra.

Nästa steg

Nu när du skapat ett anpassat anslutningsprogram och definierat dess beteenden kan du använda anslutningsprogrammet.

Du kan också dela en anslutning i din organisation och/eller få anslutningen certifierad så att personer utanför organisationen kan använda den.

Ge feedback

Vi uppskattar feedback på problem med vår plattform för anslutningsprogram eller förslag på nya funktioner. Om du vill lämna feedback går du till Skicka problem eller få hjälp med anslutningsprogram och väljer typ av feedback.