Udostępnij przez


Tworzenie łącznika niestandardowego na podstawie kolekcji w usłudze Postman

Notatka

Ten artykuł jest częścią serii samouczków dotyczących tworzenia i używania łączników niestandardowych w usługach Azure Logic Apps, Microsoft Power Automate i Microsoft Power Apps oraz wywoływania łączników jako narzędzi w programie Microsoft Copilot Studio. Należy zapoznać się z omówieniem łączników niestandardowych w celu zrozumienia procesu.

Aby utworzyć łącznik niestandardowy, opisz interfejs API, z którym chcesz nawiązać połączenie, aby łącznik rozumiał akcje interfejsu API i struktury danych. W tym artykule utworzysz łącznik niestandardowy przy użyciu kolekcji Postman , która opisuje interfejs API analizy tonacji tekstu usług Cognitive Services (przykład dla tej serii).

Inne sposoby opisywania API znajdziesz w następujących tematach:

Wymagania wstępne

Sprawdź wymagania wstępne, aby upewnić się, że masz wszystko, czego potrzebujesz do utworzenia łącznika niestandardowego. Należy wykonać:

Notatka

Postman jest jedną z opcji tworzenia kolekcji, ale można również użyć innych narzędzi, takich jak Bezsenność, aby utworzyć kolekcję na potrzeby testowania. Podczas tworzenia łącznika niestandardowego kolekcja nie może być większa niż 1 MB.*

Importuj kolekcję Postman

Teraz możesz użyć utworzonej lub pobranej kolekcji Postman. Kolekcja zawiera wiele wymaganych informacji. Możesz przejrzeć i zaktualizować te informacje podczas pracy z kreatorem łącznika niestandardowego. Zacznij od zaimportowania kolekcji Postman dla usługi Logic Apps lub usługi Power Automate i Power Apps.

Zaimportuj kolekcję Postman dla Logic Apps

  1. Przejdź do witryny Azure Portal i otwórz łącznik usługi Logic Apps utworzony wcześniej w procedurze Tworzenie łącznika niestandardowego usługi Azure Logic Apps.

  2. W menu swojego łącznika wybierz kolejno pozycje Łącznik usługi Logic Apps i wybierz Edytuj.

    Edytuj łącznik usługi Logic Apps

  3. W Ogólne wybierz kolejno pozycje Przekaż kolekcję Postman V1, a następnie przejdź do utworzonej kolekcji Postman.

    Zrzut ekranu, który pokazuje opcję Prześlij kolekcję Postman V1.

    Kreator importuje kolekcję, a następnie konwertuje ją na definicję OpenAPI o nazwie generatedApiDefinition.swagger.json.

Notatka

W tym samouczku nałożono interfejs API REST, ale można również używać interfejsu API SOAP z usługą Logic Apps.

Zaimportuj kolekcję Postman dla Power Automate i Power Apps

  1. Przejdź do obszaru make.powerapps.com lub flow.microsoft.com.

  2. W okienku nawigacji wybierz pozycję Więcej>odnajdź wszystko

  3. W sekcji Dane wybierz pozycję Łączniki niestandardowe.

  4. Wybierz pozycję Nowy łącznik niestandardowy, a następnie Importuj kolekcję Postman.

  5. Wprowadź nazwę łącznika niestandardowego, a następnie przejdź do utworzonej lub pobranej kolekcji Postman i wybierz pozycję Kontynuuj.

    Zrzut ekranu przedstawiający etapy importowania kolekcji.

    Parametr Wartość
    Tytuł łącznika niestandardowego "SentimentDemo"

    Kreator importuje kolekcję i konwertuje ją na definicję OpenAPI pod nazwą generatedApiDefinition.swagger.json.

Aktualizowanie informacji ogólnych

Od tego momentu w tym artykule przedstawiono interfejs użytkownika usługi Power Automate, ale kroki są w większości takie same we wszystkich trzech technologiach. Różnice są wyróżnione zgodnie z potrzebami.

  1. Na stronie Ogólne przejrzyj informacje zaimportowane z kolekcji Postman, w tym dane hosta i podstawowy adres URL dla interfejsu API. Łącznik używa hosta i podstawowego adresu URL do określania sposobu wywoływania interfejsu API.

    Notatka

    Aby uzyskać więcej informacji na temat łączenia się z lokalnymi interfejsami API, zobacz Łączenie się z lokalnymi interfejsami API przy użyciu bramy danych.

  2. Zaktualizuj opis, wpisując znaczące informacje. Ten opis jest wyświetlany w szczegółach łącznika niestandardowego i pomaga innym użytkownikom zrozumieć, jak łącznik jest przydatny.

    Parametr Wartość
    Opis „Korzystając z interfejsu API analizy tonacji tekstu usług Cognitive Services, określa, czy tekst jest pozytywny, czy negatywny”

Określ typ uwierzytelniania

Łączniki niestandardowe obsługują kilka opcji uwierzytelniania. Interfejsy API usług Cognitive Services używają uwierzytelniania za pomocą klucza interfejsu API.

  1. Na stronie Zabezpieczenia w obszarze Typ uwierzytelniania wybierz pozycję Klucz interfejsu API.

  2. W obszarze Klucz interfejsu API określ etykietę parametru, nazwę i lokalizację. Wybierz wyraźną i zrozumiałą etykietę. Ten tekst będzie wyświetlany użytkownikom w celu skierowania ich do nawiązywania połączeń przy użyciu łącznika niestandardowego. Lokalizacja i nazwa parametru musi odpowiadać oczekiwaniom związanym z interfejsem API (w tym przypadku nagłówek określony w narzędziu Postman). Wybierz opcję Połącz.

    Parametry klucza interfejsu API

    Parametr Wartość
    Etykieta parametru Klucz API
    Nazwa parametru "Ocp-Apim-Subscription-Key"
    Lokalizacja parametru "Header"
  3. Upewnij się, że w górnej części kreatora ustawiono nazwę „SentimentDemo”, a następnie wybierz pozycję Utwórz łącznik.

Przeglądanie i aktualizowanie definicji łącznika

Kreator spersonalizowanego łącznika oferuje wiele opcji definiowania działania i udostępniania łącznika w aplikacjach logicznych, przepływach, aplikacjach i agentach. W tej sekcji opisano interfejs użytkownika i opisano kilka opcji, ale możesz samodzielnie zapoznać się z tematem.

Przegląd interfejsu użytkownika i definicji

Przed wykonaniem kroków na stronie Definicja przejrzyj interfejs użytkownika.

  1. W tym obszarze są wyświetlane wszystkie akcje, wyzwalacze (dla usług Logic Apps i Power Automate), odwołania i zasady zdefiniowane dla łącznika. W naszym przypadku jest wyświetlana akcja DetectSentiment z kolekcji Postman. Ten łącznik nie ma żadnych wyzwalaczy, ale możesz dowiedzieć się więcej o wyzwalaczach dla łączników niestandardowych w artykule Używanie elementów webhook z usługami Azure Logic Apps i Power Automate.

    Zrzut ekranu przedstawiający akcje, wyzwalacze, odwołania i zasady, które można zdefiniować w łączniku.

  2. W obszarze Ogólne wyświetlane są informacje o aktualnie wybranym wyzwalaczu lub akcji. Te informacje pochodzą z kolekcji Postman. W tym miejscu można edytować informacje, w tym właściwość Widoczność operacji i parametrów w aplikacji logiki lub przepływie:

    • ważne: zawsze wyświetlane użytkownikowi w pierwszej kolejności
    • brak: zazwyczaj wyświetlane w aplikacji logiki lub przepływie
    • zaawansowane: początkowo ukryte w dodatkowym menu
    • wewnętrzne: niewidoczne dla użytkownika
  3. Obszar Żądanie zawiera informacje oparte na żądaniu HTTP uwzględnionym w kolekcji Postman. W tym przypadku widać, że czasownik HTTP jest ustawiony jako OPUBLIKUJ, a adres URL to „/text/analytics/v2.0/sentiment” (Pełen adres URL do interfejsu API to <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment>). Wkrótce przyjrzysz się parametrowi treści .

  4. Obszar Odpowiedź zawiera informacje oparte na odpowiedzi HTTP uwzględnionej w kolekcji Postman. W naszym przypadku jedyna zdefiniowana odpowiedź to „200” (odpowiedź oznaczająca powodzenie), ale można zdefiniować dodatkowe odpowiedzi.

  5. W obszarze Sprawdzanie poprawności są wyświetlane wszelkie problemy wykryte w definicji interfejsu API. Pamiętaj o sprawdzeniu tego obszaru przed zapisaniem łącznika.

Aktualizowanie definicji

Teraz zmień kilka ustawień, aby ułatwić korzystanie z łącznika w aplikacji logiki, usłudze Power Automate lub usłudze Power Apps.

  1. W obszarze Ogólne zaktualizuj podsumowanie na następujący opis: „Zwraca współczynnik liczbowy reprezentujący wykrytą tonację”.

  2. W obszarze Żądanie wybierz pozycję treść, a następnie pozycję Edytuj.

  3. W obszarze Parametr są teraz wyświetlane trzy parametry, których oczekuje interfejs API: id, language i text. Wybierz identyfikator, a następnie pozycję Edytuj.

  4. W obszarze Właściwości schematu zaktualizuj wartości dla parametru, a następnie wybierz pozycję Wstecz.

    Edytuj właściwość schematu

    Parametr Wartość
    Tytuł "ID"
    Opis „Identyfikator każdego przesyłanego dokumentu”
    Wartość domyślna "1"
    Wymagany "Yes"
  5. W obszarze Parametr wybierz pozycję język, a następnie pozycję Edytuj i powtórz proces, którego użyto powyżej z następującymi wartościami.

    Parametr Wartość
    Tytuł "Language"
    Opis „2- lub 4-znakowy kod języka tekstu”
    Wartość domyślna "en"
    Wymagany "Yes"
  6. W obszarze Parametr wybierz pozycję tekst, a następnie pozycję Edytuj i powtórz proces, którego użyto powyżej z następującymi wartościami.

    Parametr Wartość
    Tytuł "Tekst"
    Opis „Tekst do przeanalizowania pod kątem tonacji”
    Wartość domyślna Brak
    Wymagany "Yes"
  7. W obszarze Parametr wybierz pozycję Wstecz, aby wrócić do strony głównej definicji.

  8. W prawym górnym rogu kreatora wybierz pozycję Zaktualizuj łącznik.

Testowanie łącznika

Po utworzeniu łącznika przetestuj go, aby upewnić się, że działa prawidłowo. Testowanie jest dostępne tylko w usługach Power Automate i Power Apps.

Ważne

Gdy używasz klucza interfejsu API, poczekaj kilka minut po utworzeniu łącznika przed jego przetestowaniem. Łącznik może nie być gotowy do nawiązania połączenia z interfejsem API od razu.

  1. Na stronie Test wybierz pozycję Nowe połączenie.

  2. Wprowadź klucz interfejsu API z interfejsu API analizy tekstu, a następnie wybierz pozycję Utwórz połączenie.

  3. Wróć na stronę Testuj:

    • W usłudze Power Automate nastąpi przekierowanie do strony Testuj. Wybierz ikonę odświeżania, aby upewnić się, że informacje o połączeniu zostały zaktualizowane.
    • W usłudze Power Apps nastąpi przekierowanie do listy połączeń dostępnych w bieżącym środowisku. W prawym górnym rogu wybierz ikonę koła zębatego, a następnie wybierz pozycję Łączniki niestandardowe. Wybierz utworzony łącznik, a następnie wróć do strony Testuj.
  4. Na stronie Testuj wprowadź wartość w polu tekst (w pozostałych polach będą używane ustawione wcześniej wartości domyślne), a następnie wybierz pozycję Testuj operację.

  5. Łącznik wywołuje interfejs API i umożliwia przejrzenie odpowiedzi, która zawiera wynik opinii.

    Odpowiedź łącznika

Ograniczenia

W usługach Power Automate i Power Apps, jeśli zaktualizujesz istniejący łącznik niestandardowy przy użyciu kolekcji Postman, przed zapisaniem łącznika musisz ponownie wykonać poprzednie dostosowania. Na przykład należy ponownie skonfigurować typ uwierzytelniania i wartości domyślne parametrów dla akcji.

Następne kroki

Po utworzeniu łącznika niestandardowego i zdefiniowaniu jego zachowań użyj łącznika.

Możesz również udostępnić łącznik w organizacji lub uzyskać certyfikat łącznika, aby osoby spoza organizacji mogły z niego korzystać.

Przekazywanie opinii

Jesteśmy wdzięczni za opinie na temat problemów z platformą łączników oraz pomysły na nowe funkcje. Aby przekazać opinię, przejdź na stronę Przesyłanie problemów lub uzyskiwanie pomocy dotyczącej łączników i wybierz typ opinii.