Jak skonfigurować narzędzie Postman dla usługi Azure Digital Twins

Ważne

Wydano nową wersję usługi Azure Digital Twins. W świetle rozszerzonych możliwości nowej usługi oryginalna usługa Azure Digital Twins (opisana w tym zestawie dokumentacji) została wycofana.

Aby wyświetlić dokumentację nowej usługi, odwiedź aktywną dokumentację usługi Azure Digital Twins.

W tym artykule opisano sposób konfigurowania klienta REST postman do interakcji i testowania interfejsów API zarządzania usługą Azure Digital Twins. W szczególności opisano w nim następujące elementy:

• Jak skonfigurować aplikację usługi Azure Active Directory do korzystania z niejawnego przepływu udzielania protokołu OAuth 2.0.
• Jak używać klienta REST Postman do tworzenia żądań HTTP z obsługą tokenów do interfejsów API zarządzania.
• Jak używać narzędzia Postman do tworzenia wieloczęściowych żądań POST do interfejsów API zarządzania.

Podsumowanie narzędzia Postman

Rozpocznij pracę w usłudze Azure Digital Twins przy użyciu narzędzia klienckiego REST, takiego jak Postman , aby przygotować lokalne środowisko testowe. Klient Postman pomaga szybko tworzyć złożone żądania HTTP. Pobierz wersję klasyczną klienta Postman, przechodząc do www.getpostman.com/apps.

Postman to narzędzie do testowania REST, które lokalizuje kluczowe funkcje żądań HTTP w przydatnym graficznym interfejsie użytkownika opartym na wtyczkach.

Za pośrednictwem klienta Postman deweloperzy rozwiązań mogą określić rodzaj żądania HTTP (POST, GET, UPDATE, PATCH i DELETE), punkt końcowy interfejsu API do wywoływania i używania protokołu TLS. Narzędzie Postman obsługuje również dodawanie nagłówków żądań HTTP, parametrów, danych formularzy i treści.

Konfigurowanie usługi Azure Active Directory do korzystania z niejawnego przepływu udzielania protokołu OAuth 2.0

1. Wykonaj kroki opisane w przewodniku Szybki start, aby utworzyć i skonfigurować aplikację usługi Azure Active Directory. Alternatywnie możesz ponownie użyć istniejącej rejestracji aplikacji.

   

2. Teraz dodaj identyfikator URI przekierowania do https://www.getpostman.com/oauth2/callback.

3. Zaznacz pole wyboru Niejawne tokeny udzielania>dostępu , aby zezwolić na używanie niejawnego przepływu udzielania protokołu OAuth 2.0. Wybierz pozycję Konfiguruj, a następnie pozycję Zapisz.

4. Skopiuj identyfikator klienta aplikacji usługi Azure Active Directory.

Uzyskiwanie tokenu OAuth 2.0

W poniższych YOUR_MANAGEMENT_API_URL przykładach odwołuje się do identyfikatora URI interfejsów API usługi Digital Twins:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0

Nazwa	Zamień na
YOUR_INSTANCE_NAME	Nazwa wystąpienia usługi Azure Digital Twins
YOUR_LOCATION	Region, w którym jest hostowane twoje wystąpienie

Konfigurowanie i konfigurowanie narzędzia Postman w celu uzyskania tokenu usługi Azure Active Directory. Następnie utwórz uwierzytelnione żądanie HTTP do usługi Azure Digital Twins przy użyciu uzyskanego tokenu:

1. Sprawdź, czy adres URL autoryzacji jest poprawny. Powinien on mieć format:

   https://login.microsoftonline.com/YOUR_AZURE_TENANT.onmicrosoft.com/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
   

   Nazwa	Zamień na	Przykład
   YOUR_AZURE_TENANT	Nazwa dzierżawy lub organizacji. Użyj przyjaznej dla człowieka nazwy zamiast alfanumerycznego identyfikatora dzierżawy rejestracji aplikacji usługi Azure Active Directory.	microsoft

2. Przejdź do www.getpostman.com , aby pobrać aplikację.

3. Chcemy wysłać żądanie GET. Wybierz kartę Autoryzacja , wybierz pozycję OAuth 2.0, a następnie wybierz pozycję Pobierz nowy token dostępu.

   Pole	Wartość
   Typ udzielenia	Implicit
   Adres URL wywołania zwrotnego	https://www.getpostman.com/oauth2/callback
   Adres URL uwierzytelniania	Użyj adresu URL autoryzacji z kroku 1
   Identyfikator klienta	Użyj identyfikatora aplikacji dla aplikacji usługi Azure Active Directory, która została utworzona lub użyta ponownie w poprzedniej sekcji
   Zakres	Pozostaw puste.
   Stan	Pozostaw puste.
   Uwierzytelnianie klienta	Send as Basic Auth header

4. Klient powinien teraz wyglądać następująco:

   

5. Wybierz pozycję Request Token (Zażądaj tokenu).

6. Przewiń w dół i wybierz pozycję Użyj tokenu.

Tworzenie żądania POST z wieloma częściami

Po wykonaniu poprzednich kroków skonfiguruj narzędzie Postman w celu utworzenia uwierzytelnionego żądania POST wieloczęściowego PROTOKOŁU HTTP:

1. Na karcie Nagłówki dodaj klucz nagłówka żądania HTTP Content-Type z wartością multipart/mixed.

   

2. Serializuj dane nietekstowe do plików. Dane JSON zostaną zapisane jako plik JSON.

3. Na karcie Treść wybierz pozycję form-data.

4. Dodaj każdy plik, przypisując nazwę klucza , wybierając Filepozycję .

5. Następnie wybierz każdy plik za pomocą przycisku Wybierz plik .

   

   Uwaga

   • Klient postman nie wymaga, aby fragmenty wieloczęściowe miały ręcznie przypisany typ zawartości lub dyspozycję zawartości.
   • Nie trzeba określać tych nagłówków dla każdej części.
   • Musisz wybrać multipart/mixed lub inny odpowiedni typ zawartości dla całego żądania.

6. Na koniec wybierz pozycję Wyślij , aby przesłać wieloczęściowe żądanie HTTP POST. Kod 200 stanu lub 201 wskazuje pomyślne żądanie. Odpowiedni komunikat odpowiedzi pojawi się w interfejsie klienta.

7. Zweryfikuj dane żądania HTTP POST, wywołując punkt końcowy interfejsu API:

   YOUR_MANAGEMENT_API_URL/spaces/blobs?includes=description
   

Następne kroki

• Aby dowiedzieć się więcej na temat interfejsów API zarządzania usługą Digital Twins i sposobu ich używania, przeczytaj Artykuł How to use Azure Digital Twins management APIs (Jak używać interfejsów API zarządzania usługą Azure Digital Twins).

• Użyj żądań wieloczęściowych, aby dodać obiekty blob do jednostek usługi Azure Digital Twins.

• Aby dowiedzieć się więcej na temat uwierzytelniania za pomocą interfejsów API zarządzania, przeczytaj Uwierzytelnianie przy użyciu interfejsów API.