Postman'i kullanarak Azure Digital Twins API'lere istek gönderme

Postman, masaüstü ve eklenti tabanlı GUI'de önemli HTTP isteği işlevleri sağlayan bir REST test aracıdır. HTTP istekleri hazırlar ve bunları rest API'leri Azure Digital Twins kullanabilirsiniz.

Bu makalede, aşağıdaki adımları kullanarak Postman REST istemcisini Azure Digital Twins için yapılandırma adımları açıklanmıştır:

1. Postman'de API isteklerinde kullanmak üzere bir taşıyıcı belirteç almak için Azure CLI'yi kullanın.
2. Bir Postman koleksiyonu ayarlayın ve Postman REST istemcisini kimlik doğrulaması için taşıyıcı belirtecini kullanmak üzere yapılandırarak. Koleksiyonu ayarlarken şu seçeneklerden birini seçebilirsiniz:
   1. Api isteklerinin önceden Azure Digital Twins koleksiyonunu içeri aktarın.
   2. Sıfırdan kendi koleksiyonunızı oluşturun.
3. Yapılandırılan koleksiyonunuz için istek ekleyin ve bunları Azure Digital Twins gönderin.

Azure Digital Twins üzerinde çalışabilirsiniz: veri düzlemi ve kontrol düzlemi. Bu API kümeleri arasındaki fark hakkında daha fazla bilgi için bkz. Azure Digital Twins API'ler ve API'ler. Bu makale her iki API kümesi için de bilgi içerir.

Önkoşullar

Azure Digital Twins API'lerine erişmek için Postman'ı kullanmaya devam etmek için bir Azure Digital Twins örneği ayarlamalı ve Postman'i indirmeniz gerekir. Bu bölümün geri kalanında bu adımlarda size yol veacağız.

Örnek Azure Digital Twins ayarlama

Bu makalede Azure Digital TWINS ile çalışmak için önce bir Azure dijital TWINS örneği ayarlamanız gerekir. Ayrıca, kullanmak için gerekli izinlere de ihtiyacınız vardır. Zaten ayarlanmış bir Azure dijital TWINS örneğiniz varsa, bunun yerine kullanabilirsiniz.

Aksi takdirde, örnek ayarlama ve kimlik doğrulamabölümündeki yönergeleri izleyin. Yönergeler, her adımı başarıyla tamamladığınızı doğrulamanıza yardımcı olacak bilgiler içerir.

Örneğinizi ayarladıktan sonra, aşağıdaki değerleri unutmayın. Örneğe daha sonra bağlanmak için bu değerlere ihtiyacınız olacak:

• Örneğin ana bilgisayar adı. Ana bilgisayar adını Azure Portal bulabilirsiniz.
• Örneği oluşturmak için kullandığınız Azure aboneliği . Adı veya KIMLIĞI çalışır durumda. Aboneliğinizi, Azure Portalörneğinizin genel bakış sayfasında bulabilirsiniz.

Postman'i indirin

Ardından, Postman istemcisinin masaüstü sürümünü indirin.

Taşıyıcı belirteci al

Postman'i ve Azure Digital Twins örneğinizi ayarlaycınıza göre, Postman isteklerinin Azure Digital Twins API'lerine karşı yetkilendirmek için kullanabileceği bir taşıyıcı Azure Digital Twins gerekir.

Bu belirteci almak için birkaç olası yol vardır. Bu makalede Azure cli kullanarak Azure hesabınızla oturum açın ve bu şekilde bir belirteç alın.

Yerel olarak yüklenmiş bir Azure CLI'nizvarsa, aşağıdaki komutları çalıştırmak için makinenize bir komut istemi başlatabilirsiniz. Aksi takdirde tarayıcınızda bir Azure Cloud Shell penceresi açıp komutları orada çalıştırabilirsiniz.

1. İlk olarak, şu komutu çalıştırarak uygun kimlik bilgileriyle Azure'da oturum açtığınızdan emin olun:

   az login
   

2. Ardından, az account get-access-token komutunu kullanarak Azure Digital Twins hizmetine erişimi olan bir taşıyıcı Azure Digital Twins alın. Bu komutta, Azure Digital Twins kaynaklarına erişen bir erişim belirteci almak için Azure Digital Twins geçebilirsiniz.

   Belirteç için gerekli bağlam, kullandığınız API kümesine bağlıdır, bu nedenle veri düzlemi ve kontrol düzlemi API'leri arasında seçim yapmak için aşağıdaki sekmeleri kullanın.

   • Veri düzlemi
   • Kontrol düzlemi

   Veri düzlemi API'leriyle kullanmak üzere bir belirteç almak için belirteç bağlamı için aşağıdaki statik değeri kullanın: 0b07f429-9f4b-4714-9392-cc5e8e80c8b0 . Bu, hizmet uç noktasının Azure Digital Twins kimliğidir.

   az account get-access-token --resource 0b07f429-9f4b-4714-9392-cc5e8e80c8b0
   

   Not

   Azure Digital Twins örneğinden farklı bir Azure Active Directory kiracısına ait bir hizmet sorumlusu veya kullanıcı hesabı kullanarak Azure Digital Twins örneğine erişmeniz gerekirse, Azure Digital Twins örneğinin "home" kiracısı için bir belirteç isteğide bulundurabilirsiniz. Bu işlem hakkında daha fazla bilgi için bkz. Uygulama kimlik doğrulama kodu yazma.

3. Sonuçta accessToken değerini kopyalayın ve sonraki bölümde kullanmak üzere kaydedin. Bu, postman'e isteklerinizi yetkilendirmek için belirteci değerinizdir.

   

Ardından Postman'i bu belirteci kullanarak bu belirteci kullanarak api istekleri Azure Digital Twins.

Postman koleksiyonları hakkında

Postman'daki istekler koleksiyonlara (istek grupları) kaydedilir. İsteklerinizi gruplatıracak bir koleksiyon oluşturdukta, ortak ayarları aynı anda birçok iraca uygulayabilirsiniz. Bu, tüm koleksiyon için yalnızca bir kez yapılandırmanız gerekerek Azure Digital Twins API'ler için birden fazla istek oluşturmayı planlıyorsanız yetkilendirmeyi büyük ölçüde basitleştirebilir.

Azure Digital Twins ile çalışırken, tüm veri isteklerinin önceden Azure Digital Twins içeri aktararak çalışmaya Azure Digital Twins. API'leri keşfediyorsanız ve istek örnekleriyle hızla bir proje ayarlamak istiyorsanız bunu yapmak iyi olabilir.

Alternatif olarak, kendi boş koleksiyonlarınızı oluşturarak ve yalnızca ihtiyacınız olan API'leri çağıran tek tek isteklerle doldurmakla sıfırdan başlamayı da seçebilirsiniz.

Aşağıdaki bölümlerde bu işlemlerin her ikisi de açıklanmaktadır. Makalenin geri kalanı yerel Postman uygulamanıza aittir, bu nedenle şimdi bilgisayarınızda Postman uygulamasını açın.

Api'lerden Azure Digital Twins içeri aktarma

Postman'de Azure Digital Twins hızlı bir yol, Azure Digital Twins API'leri için önceden Azure Digital Twins almaktır.

Koleksiyon dosyasını indirme

API kümesi içeri aktarmanın ilk adımı bir koleksiyon indirmektir. Önceden yapılmış koleksiyon seçeneklerini görmek için veri düzlemi veya kontrol düzlemi seçiminiz için aşağıdaki sekmeyi seçin.

Seçtiğiniz koleksiyonu Postman'e içeri aktararak makinenize indirmeyi burada indirebilirsiniz.

1. Yukarıdaki bağlantıları kullanarak koleksiyon dosyasını tarayıcınızda GitHub açın.
2. Dosyanın ham metnini açmak için Ham düğmesini seçin.
3. Pencereden metni kopyalayın ve makinenizin yeni bir dosyasına yapıştırın.
4. Dosyayı bir .json uzantısıyla kaydedin (dosyayı daha sonra bulmak için anımsayabilirsiniz ancak dosya adı istediğiniz gibi olabilir).

Koleksiyonu içeri aktarma

Ardından, koleksiyonu Postman'e aktarın.

1. Ana Postman penceresinde İçeri Aktar düğmesini seçin.

2. Aşağıdaki İçeri Aktar penceresinde Dosyalar'Upload seçin ve daha önce oluşturduğunuz makinede koleksiyon dosyasına gidin. Aç’ı seçin.

3. Onaylamak için İçeri Aktar düğmesini seçin.

   

Yeni içe aktarılan koleksiyon artık koleksiyonlar sekmesindeki ana Postman görünümden görülebilir.

Ardından, yetkilendirme için koleksiyona bir taşıyıcı belirteç eklemek ve bunu Azure Digital Twins örneğiniz ile bağlamak için sonraki bölüme devam edin.

Yetkilendirmeyi yapılandırma

Ardından, bazı erişim ayrıntılarını yapılandırmak için oluşturduğunuz koleksiyonu düzenleyin. Oluşturduğunuz koleksiyonu vurgulayın ve Daha fazla eylem görüntüle simgesini seçerek bir menü açın. Düzenle'yi seçin.

Yetkilendirme için koleksiyona taşıyıcı belirteç eklemek için bu adımları izleyin. Burası, koleksiyonunuzla ilgili tüm API isteklerinde kullanmak üzere Taşıyıcı belirteci al bölümünde toplanmış belirteç değerini kullanabileceğiniz yerdir.

1. Koleksiyonun düzenle iletişim kutusunda Yetkilendirme sekmesinde olduğundan emin olun.

   

2. Türü OAuth 2,0 olarak ayarlayın, erişim belirtecinizi erişim belirteci kutusuna yapıştırın ve Kaydet' i seçin.

   

Ek yapılandırma

İstekleri keşfet

Ardından, Azure Digital TWINS API koleksiyonu içindeki istekleri keşfedebilirsiniz. Önceden oluşturulmuş istekleri görüntülemek için koleksiyonu genişletebilirsiniz (işlem kategorisine göre sıralanır).

Farklı istekler, örneğiniz ve verileri hakkında farklı bilgiler gerektirir. Belirli bir isteği yapmak için gereken tüm bilgileri görmek için, Azure Digital TWINS REST API başvuru belgelerindekiistek ayrıntılarına bakın.

Aşağıdaki adımları kullanarak Postman koleksiyonundaki bir isteğin ayrıntılarını düzenleyebilirsiniz:

1. Düzenlenebilir ayrıntılarını çekmek için listeden seçin.

2. Yol değişkenleri altındaki params sekmesinde listelenen değişkenlerin değerlerini girin.

   

3. İlgili sekmelerde gerekli üstbilgileri veya gövde ayrıntılarını sağlayın.

Tüm gerekli ayrıntılar sağlandıktan sonra, isteği Gönder düğmesiyle çalıştırabilirsiniz.

Ayrıca, aşağıdaki tek bir Istek Ekle bölümünde açıklanan süreci kullanarak kendi isteklerinizi koleksiyona ekleyebilirsiniz.

Kendi koleksiyonunuzu oluşturun

Tüm Azure dijital TWINS API 'Lerinin mevcut koleksiyonunu içeri aktarmak yerine, kendi koleksiyonunuzu sıfırdan da oluşturabilirsiniz. Daha sonra Azure Digital TWINS REST API başvuru belgelerinikullanarak bireysel isteklerle doldurabilirsiniz.

Postman koleksiyonu oluşturma

1. Bir koleksiyon oluşturmak için, ana Postman penceresindeki Yeni düğmesini seçin.

   

   Bir koleksiyon türü seçin.

   

2. Bu, yeni koleksiyonun ayrıntılarının doldurulmasıyla ilgili bir sekme açar. Koleksiyonun varsayılan adının yanındaki Düzenle simgesini seçin (Yeni koleksiyon) ve kendi adınızla değiştirin.

   

Daha sonra, yetkilendirme için koleksiyona bir taşıyıcı belirteci eklemek üzere bir sonraki bölüme devam edin.

Yetkilendirmeyi yapılandırma

Yetkilendirme için koleksiyona bir taşıyıcı belirteci eklemek için bu adımları izleyin. Burada, koleksiyonunuzdaki tüm API istekleri için kullanmak üzere taşıyıcı belirtecini al bölümünde topladığınız belirteç değerini kullanacaksınız.

1. Yine de yeni koleksiyonunuz için düzenleme iletişim kutusunda, Yetkilendirme sekmesine geçin.

   

2. Türü OAuth 2,0 olarak ayarlayın, erişim belirtecinizi erişim belirteci kutusuna yapıştırın ve Kaydet' i seçin.

   

Yukarıdaki adımlarla işiniz bittiğinde, koleksiyonu yapılandırmayı tamamladınız demektir. İsterseniz yeni koleksiyon için düzenleme sekmesini kapatabilirsiniz.

Yeni koleksiyon, Koleksiyonlar sekmesindeki Ana Postman görünümünüze görünebilir.

Tek bir istek ekleyin

Koleksiyonunuz ayarlandığına göre, Azure Digital Ikizi API 'Lerine kendi isteklerinizi ekleyebilirsiniz.

1. Bir istek oluşturmak için Yeni düğmesini yeniden kullanın.

   

   İstek türü seçin.

   

2. Bu eylem, isteğiniz için bir ad girebileceğiniz Istek Kaydet penceresini açar, isteğe bağlı bir açıklama verebilir ve bir parçası olan koleksiyonu seçebilir. Ayrıntıları girin ve isteği daha önce oluşturduğunuz koleksiyona kaydedin.

   

Artık isteğinizi koleksiyon altında görüntüleyebilir ve düzenlenebilir ayrıntılarını almak için bu seçeneği belirleyebilirsiniz.

İstek ayrıntılarını ayarla

Azure dijital TWINS API 'Lerinden birine bir Postman isteği yapmak için API 'nin URL 'SI ve gerektirdiği ayrıntıları hakkında bilgi almanız gerekir. Bu bilgileri Azure Digital TWINS REST API başvuru belgelerindebulabilirsiniz.

Örnek sorgu ile devam etmek için bu makalede sorgu API 'SI (ve başvuru belgeleri) kullanılarak bir örnekteki tüm dijital TWINS 'leri sorgulama yapılır.

1. Başvuru belgelerinden istek URL 'sini ve türünü alın. Sorgu API 'SI için bu şu anda göndermekte https://digitaltwins-host-name/query?api-version=2020-10-31 .

2. Postman 'da, istek için türü ayarlayın ve URL 'de yer tutucuları gerektiği şekilde doldurarak istek URL 'sini girin. Bunun nedeni, Önkoşul bölümündeörneğinizin ana bilgisayar adını kullanacaksınız.

   

3. Params sekmesindeki istek için gösterilen parametrelerin başvuru belgelerinde açıklananlar ile eşleşip eşleşmediğinden emin olun. Postman 'daki bu istek için, api-version önceki adımda istek URL 'si girildiğinde parametre otomatik olarak doldurulmuştur. Sorgu API 'SI için bu tek gerekli parametredir, bu nedenle bu adım yapılır.

4. Yetkilendirme sekmesinde, türü üst öğeden kimlik doğrulamasını devralacak şekilde ayarlayın. Bu, bu isteğin, daha önce tüm koleksiyon için ayarladığınız yetkilendirmeyi kullanacağını gösterir.

5. Üst bilgiler sekmesindeki istek için gösterilen üst bilgilerin, başvuru belgelerinde açıklananlarla eşleştiğinden emin olun. Bu istek için, birkaç üst bilgi otomatik olarak doldurulmuştur. Sorgu API 'SI için üst bilgi seçeneklerinden hiçbiri gerekli değildir, bu nedenle bu adım yapılır.

6. Gövde sekmesindeki istek için gösterilen gövdenin, başvuru belgelerinde açıklanan gereksinimle eşleşip eşleşmediğini denetleyin. Sorgu API 'SI için, sorgu metnini sağlamak üzere bir JSON gövdesi gerekir. İşte, örnekteki tüm dijital TWINS sorgularını sorgulayan bu istek için örnek bir gövde:

   

   Azure dijital TWINS sorguları oluşturma hakkında daha fazla bilgi için bkz. ikizi grafiğini sorgulama.

7. İstek türü için gerekebilecek diğer alanlar için başvuru belgelerini denetleyin. Sorgu API 'SI için, tüm gereksinimler Postman isteğinde karşılanmıştır, bu nedenle bu adım yapılır.

8. Tamamlanan isteğinizi göndermek için Gönder düğmesini kullanın.

İsteği gönderdikten sonra, yanıt ayrıntıları isteğin altındaki Postman penceresinde görüntülenir. Yanıtın durum kodunu ve tüm gövde metinlerini görüntüleyebilirsiniz.

Ayrıca, sonucu doğrulamak veya ortaya çıkan hatalar hakkında daha fazla bilgi edinmek için başvuru belgelerinde verilen beklenen yanıt verileriyle yanıtı karşılaştırabilirsiniz.

Sonraki adımlar

Dijital TWINS API 'Leri hakkında daha fazla bilgi edinmek için Azure Digital TWINS API 'leri ve SDK'ları okuyun veya REST API 'lerinin başvuru belgelerinigörüntüleyin.