Azure dijital TWINS için Postman 'ı yapılandırmaHow to configure Postman for Azure Digital Twins

Bu makalede, Azure Digital TWINS yönetim API 'Lerini ile etkileşime geçmek ve test etmek üzere Postman REST istemcisinin nasıl yapılandırılacağı açıklanır.This article describes how to configure the Postman REST client to interact with and test the Azure Digital Twins Management APIs. Özellikle şunları açıklar:Specifically, it describes:

  • Azure Active Directory uygulamasını OAuth 2,0 örtük izin akışını kullanacak şekilde yapılandırma.How to configure an Azure Active Directory application to use the OAuth 2.0 implicit grant flow.
  • Yönetim API 'lerinize belirteç oluşturma HTTP istekleri yapmak için Postman REST istemcisini kullanma.How to use the Postman REST client to make token-bearing HTTP requests to your Management APIs.
  • Yönetim API 'lerinize çok parçalı GÖNDERI istekleri yapmak için Postman 'ı kullanma.How to use Postman to make multipart POST requests to your Management APIs.

Postman ÖzetiPostman summary

Yerel test ortamınızı hazırlamak için Postman gıbı bir rest istemci aracı kullanarak Azure dijital TWINS 'i kullanmaya başlayın.Get started on Azure Digital Twins by using a REST client tool such as Postman to prepare your local testing environment. Postman istemcisi, karmaşık HTTP isteklerinin hızla oluşturulmasına yardımcı olur.The Postman client helps to quickly create complex HTTP requests. Www.getpostman.com/apps'e giderek Postman istemcisinin Masaüstü sürümünü indirin.Download the desktop version of the Postman client by going to www.getpostman.com/apps.

Postman , önemli http istek işlevlerini yararlı bir masaüstü ve EKLENTI tabanlı GUI 'ye bulan bir rest test aracıdır.Postman is a REST testing tool that locates key HTTP request functionalities into a useful desktop and plugin-based GUI.

Çözüm geliştiricileri Postman istemcisi aracılığıyla HTTP isteği türünü (gönderi, Al, Güncelleştir, Düzeltme Ekiuygulama ve silme), API 'yi çağırmak için API uç noktası ve SSL kullanımını belirtebilir.Through the Postman client, solutions developers can specify the kind of HTTP request (POST, GET, UPDATE, PATCH, and DELETE), API endpoint to call, and use of SSL. Postman ayrıca HTTP istek üstbilgileri, parametreleri, form verileri ve gövdeleri eklemeyi destekler.Postman also supports adding HTTP request headers, parameters, form-data, and bodies.

OAuth 2,0 örtük izin akışını kullanmak için Azure Active Directory yapılandırmaConfigure Azure Active Directory to use the OAuth 2.0 implicit grant flow

Azure Active Directory uygulamanızı OAuth 2,0 örtük izin akışını kullanacak şekilde yapılandırın.Configure your Azure Active Directory app to use the OAuth 2.0 implicit grant flow.

  1. Uygulama kaydınız için API izinleri bölmesini açın.Open the API permissions pane for your app registration. Izin Ekle düğmesini seçin.Select Add a permission button. API Izinleri iste bölmesinde Kuruluşumun kullandığı API 'leri seçin ve ardından şunu arayın:In the Request API permissions pane, select the APIs my organization uses tab, and then search for:

    1. Azure Digital Twins.Azure Digital Twins. Azure dijital TWINS API 'sini seçin.Select the Azure Digital Twins API.

      arama API 'SI veya Azure dijital TWINSSearch API or Azure Digital Twins

    2. Alternatif olarak, Azure Smart Spaces Serviceiçin arama yapın.Alternatively, search for Azure Smart Spaces Service. Azure akıllı boşluklar hizmeti API 'sini seçin.Select the Azure Smart Spaces Service API.

      Azure akıllı alanları için Search API Search API for Azure Smart Spaces

    Önemli

    Görüntülenecek Azure AD API adı ve KIMLIĞI, kiracınıza bağlı olarak değişir:The Azure AD API name and ID that will appear depends on your tenant:

    • Test kiracının ve müşteri hesaplarının Azure Digital Twinsaraması gerekir.Test tenant and customer accounts should search for Azure Digital Twins.
    • Diğer Microsoft hesaplarının Azure Smart Spaces Servicearaması gerekir.Other Microsoft accounts should search for Azure Smart Spaces Service.
  2. Seçilen API, aynı istek API 'si izinleri bölmesinde Azure dijital TWINS olarak gösterilir.The selected API shows up as Azure Digital Twins in the same Request API permissions pane. Oku (1) açılır öğesini seçin ve ardından oku. yazma onay kutusunu seçin.Select the Read (1) drop down, and then select Read.Write checkbox. Izin Ekle düğmesini seçin.Select the Add permissions button.

    API izinleri eklemeAdd API permissions

  3. Kuruluşunuzun ayarlarına bağlı olarak, bu API 'ye yönetici erişimi sağlamak için ek adımlar gerçekleştirmeniz gerekebilir.Depending on your organization's settings, you might need to take additional steps to grant admin access to this API. Daha fazla bilgi için yöneticinize başvurun.Contact your administrator for more information. Yönetici erişimi onaylandıktan sonra API izinleri BÖLMESINDEKI yönetici onayı gerekli sütunu, API 'leriniz için aşağıdakine benzer şekilde görünür:Once the admin access is approved, the ADMIN CONSENT REQUIRED column in the API permissions pane will show similar to the following for your APIs:

    Yönetici onay onayını Admin consent approval

  4. İkinci bir yeniden yönlendirme URI 'sini https://www.getpostman.com/oauth2/callbackiçin yapılandırın.Configure a second Redirect URI to https://www.getpostman.com/oauth2/callback.

    Postman yeniden yönlendirme URI 'SI EkleAdd a Postman Redirect URI

  5. Uygulamanın bir ortak istemciolarak kaydedildiğindenemin olmak için, uygulama kaydlarınızın kimlik doğrulama bölmesini açın ve bu bölmeyi aşağı kaydırın.To make sure that the app is registered as a public client, open the Authentication pane for your app registration, and scroll down in that pane. Varsayılan istemci türü bölümünde, uygulamayı ortak istemci olarak değerlendir' i seçin ve Kaydet' i tıklayın.In the Default client type section, choose Yes for Treat application as a public client, and hit Save.

    Manifest. JSON 'inizdeki oauth2AllowImplicitFlow ayarını etkinleştirmek için erişim belirteçlerini denetleyin.Check Access tokens to enable the oauth2AllowImplicitFlow setting in your Manifest.json.

    ortak istemci yapılandırma ayarıPublic client configuration setting

  6. Azure Active Directory uygulamanızın uygulama kimliğini kopyalayın ve saklayın.Copy and keep the Application ID of your Azure Active Directory app. Bu, izleyen adımlarda kullanılır.It's used in the steps that follow.

    Azure Active Directory uygulama KIMLIĞIAzure Active Directory application ID

OAuth 2,0 belirteci edinmeObtain an OAuth 2.0 token

Aşağıdaki örneklerde YOUR_MANAGEMENT_API_URL, dijital TWINS API 'Lerinin URI 'sine başvurur:In the examples below, YOUR_MANAGEMENT_API_URL refers to the URI of the Digital Twins APIs:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0
AdName Şununla değiştirReplace with
YOUR_INSTANCE_NAMEYOUR_INSTANCE_NAME Azure dijital TWINS örneğinizin adıThe name of your Azure Digital Twins instance
YOUR_LOCATIONYOUR_LOCATION Örneğinizin barındırıldığı bölgeThe region your instance is hosted on

Azure Active Directory belirtecini almak için Postman ayarlayın ve yapılandırın.Set up and configure Postman to obtain an Azure Active Directory token. Daha sonra, alınan belirteci kullanarak Azure dijital TWINS 'e kimliği doğrulanmış bir HTTP isteği oluşturun:Afterwards, make an authenticated HTTP request to Azure Digital Twins using the acquired token:

  1. Uygulamayı indirmek için www.getpostman.com adresine gidin.Go to www.getpostman.com to download the app.

  2. YETKILENDIRME URL 'nizin doğru olduğundan emin olun.Verify that your Authorization URL is correct. Şu biçimde olmalıdır:It should take the format:

    https://login.microsoftonline.com/YOUR_AZURE_TENANT.onmicrosoft.com/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
    
    AdName Şununla değiştirReplace with ÖrnekExample
    YOUR_AZURE_TENANTYOUR_AZURE_TENANT Kiracınızın veya kuruluşunuzun adıThe name of your tenant or organization microsoft
  3. Yetkilendirme sekmesini seçin, OAuth 2,0' i seçin ve ardından Yeni erişim belirteci al' ı seçin.Select the Authorization tab, select OAuth 2.0, and then select Get New Access Token.

    AlanField DeğerValue
    Verme türüGrant Type Implicit
    Geri çağırma URL 'SICallback URL https://www.getpostman.com/oauth2/callback
    Kimlik doğrulama URL 'SIAuth URL 2. adımdaki yetkilendirme URL 'sini kullanınUse the Authorization URL from step 2
    İstemci KimliğiClient ID Önceki bölümden oluşturulmuş veya yeniden kullanılan Azure Active Directory uygulamasının uygulama kimliğini kullanınUse the Application ID for the Azure Active Directory app that was created or reused from the previous section
    KapsamScope Boş bırakınLeave blank
    DurumState Boş bırakınLeave blank
    İstemci kimlik doğrulamasıClient Authentication Send as Basic Auth header
  4. İstemci şu şekilde görünmelidir:The client should now appear as:

    Postman istemci örneğiPostman client example

  5. Istek belirteciniseçin.Select Request Token.

  6. Aşağı kaydırın ve belirteci kullan' ı seçin.Scroll down, and select Use Token.

Çok parçalı bir POST isteği oluşturunMake a multipart POST request

Önceki adımları tamamladıktan sonra, kimliği doğrulanmış bir HTTP çok parçalı GÖNDERI isteği oluşturmak için Postman 'ı yapılandırın:After completing the previous steps, configure Postman to make an authenticated HTTP multipart POST request:

  1. Üst bilgiler sekmesi ALTıNA bir http istek üst bilgisi anahtarı Content-Type değeri multipart/mixedekleyin.Under the Headers tab, add an HTTP request header key Content-Type with value multipart/mixed.

    Içerik türü parçalı/karışıkContent type multipart/mixed

  2. Metin olmayan verileri dosyalara serileştirme.Serialize non-text data into files. JSON verileri bir JSON dosyası olarak kaydedilir.JSON data would be saved as a JSON file.

  3. Gövde sekmesinde form-data' yi seçin.Under the Body tab, select form-data.

  4. Her dosyayı bir anahtar adı atayarak ekleyin, Fileöğesini seçin.Add each file by assigning a key name, selecting File.

  5. Sonra, Dosya Seç düğmesini kullanarak her bir dosyayı seçin.Then, select each file through the Choose File button.

    Postman istemci örneğiPostman client example

    Not

    • Postman istemcisi, çok parçalı öbeklerin el ile atanmış bir Içerik türü veya Content-Dispositionolmasını gerektirmez.The Postman client does not require that multipart chunks have a manually assigned Content-Type or Content-Disposition.
    • Her bölüm için bu üst bilgileri belirtmeniz gerekmez.You do not need to specify those headers for each part.
    • Tüm istek için multipart/mixed veya başka bir uygun Içerik türü seçmelisiniz.You must select multipart/mixed or another appropriate Content-Type for the entire request.
  6. Son olarak, çok parçalı HTTP POST isteğinizi göndermek için Gönder ' i seçin.Lastly, select Send to submit your multipart HTTP POST request. 200 veya 201 durum kodu başarılı bir isteği gösterir.A status code of 200 or 201 indicates a successful request. Ayrıca ilgili yanıt iletisini görürsünüz.You will also see the appropriate response message.

Sonraki adımlarNext steps