Öğretici: Azure IoT Central uygulamasını yönetmek için REST API kullanma

Makale
03/04/2024

Bu öğreticide, Bir IoT Central uygulaması oluşturmak ve bunlarla etkileşim kurmak için Azure IoT Central REST API'sini nasıl kullanacağınız gösterilmektedir. Bu öğreticide, hızlı başlangıçlarda Web kullanıcı arabirimini kullanarak tamamladığınız adımların çoğunu tamamlamak için REST API kullanılır. Bu adımlar, akıllı telefonunuzdaki bir uygulamayı IoT Central'a bağlanan bir IoT cihazı olarak kullanmayı içerir.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

REST API'yi yetkilendirme.
IoT Central uygulaması oluşturma.
Uygulamanıza bir cihaz ekleyin.
Cihazı sorgulayıp kontrol edin.
Veri dışarı aktarmayı ayarlama.
Bir uygulamayı silin.

Önkoşullar

Bu öğreticideki adımları tamamlamak için şunları yapmanız gerekir:

Etkin bir Azure aboneliği. Azure aboneliğiniz yoksa başlamadan önce ücretsiz bir hesap oluşturun.
Resmi uygulama mağazalarından birinden ücretsiz bir uygulama yükleyebileceğiniz bir Android veya iOS akıllı telefon.

Azure CLI

Bazı REST API'lerinin yetkilendirme için kullandığı taşıyıcı belirteçleri oluşturmak için Azure CLI'yi kullanırsınız.

Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz . Azure Cloud Shell'de Bash için hızlı başlangıç.
CLI başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.
- Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz . Azure CLI ile oturum açma.
- İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma.
- Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

Postman

Bu öğreticide, REST API çağrıları yapmak için Postman'i kullanacaksınız. Postman'i indirip yüklememek isterseniz çevrimiçi sürümü kullanabilirsiniz. Postman'in ücretsiz sürümünü kullanarak öğreticideki tüm adımları tamamlayabilirsiniz.

Öğretici, adımları tamamlamanıza yardımcı olmak için bazı betikler içeren önceden tanımlanmış bir Postman koleksiyonu kullanır.

Postman koleksiyonunu içeri aktarma

Koleksiyonu içeri aktarmak için Postman'i açın ve İçeri Aktar'ı seçin. İçeri Aktar iletişim kutusunda Bağlantı'yı seçin ve aşağıdaki URL'yi yapıştırın, Devam'ı seçin.

Çalışma alanınız artık IoT Central REST öğretici koleksiyonunu içerir. Bu koleksiyon, öğreticide kullandığınız tüm API'leri içerir.

Koleksiyon, REST API çağrılarını parametreleştirmek için değişkenleri kullanır. Değişkenleri görmek için IoT Central REST öğreticisinin ... yanındaki öğesini ve ardından Düzenle'yi seçin. Ardından Değişkenler'i seçin. Değişkenlerin çoğu, SIZ API çağrıları yaparken otomatik olarak ayarlanır veya önceden ayarlanmış değerlere sahiptir.

REST API'yi yetkilendirme

REST API'yi kullanabilmeniz için yetkilendirmeyi yapılandırmanız gerekir. Bu öğreticideki REST API çağrıları üç yetkilendirme türünden birini kullanır:

öğesine erişim https://management.azure.comyetkisi veren taşıyıcı belirteci. Ve IoT Central uygulamasını oluştururken ve silerken bu taşıyıcı belirteci kullanırsınız. IoT Central uygulaması bir Azure kaynağıdır.
öğesine erişim https://apps.azureiotcentral.comyetkisi veren taşıyıcı belirteci. IoT Central uygulamasında API belirteçleri oluşturmak için bu taşıyıcı belirtecini kullanırsınız.
IoT Central uygulamanızdaki özelliklere erişim yetkisi veren yönetici ve işleç API'si belirteçleri. Bu öğreticideki API çağrılarının çoğu için bu belirteçleri kullanırsınız. Bu belirteçler yalnızca belirli bir IoT Central uygulamasına erişim yetkisi sağlar.

Postman koleksiyonunda aşağıdaki değişkenlere değer atayın:

bearerToken: erişim yetkisi veren bir taşıyıcı belirteci oluşturmak için aşağıdaki Azure CLI komutlarını https://management.azure.comçalıştırın:
```
az login
az account get-access-token --resource https://management.azure.com
```
İpucu

Cloud Shell kullanıyor olsanız bile çalıştırmanız az login gerekebilir.

accessToken Değeri koleksiyon değişkenlerinde bearerToken için Current value sütununa kopyalayın.
bearerTokenApp: erişim yetkisi veren bir taşıyıcı belirteci oluşturmak için aşağıdaki Azure CLI komutlarını https://apps.azureiotcentral.comçalıştırın:
```
az account get-access-token --resource https://apps.azureiotcentral.com
```
İpucu

Kabuğunuzun yeni bir örneğini başlattıysanız yeniden çalıştırın az login .

accessToken Değeri koleksiyon değişkenlerinde bearerTokenApp için Geçerli değer sütununa kopyalayın.
subscriptionId: Abonelik kimliğiniz önceki iki komutun çıkışına dahil edildi. subscription Değeri koleksiyon değişkenlerindeki subscriptionId için Geçerli değer sütununa kopyalayın.

Postman koleksiyonunda el ile ayarlanan değişkenleri gösteren ekran görüntüsü.

Değişiklikleri Postman koleksiyonuna kaydettiğinizden emin olun.

Not

Taşıyıcı belirteçlerin süresi bir saat sonra dolar.

Uygulama oluşturma

IoT central uygulamaları oluşturmak ve yönetmek için denetim düzlemi isteklerini kullanın. Bu öğreticide kullandığınız uygulamayı oluşturmak için aşağıdaki PUT isteğini kullanın. İstek, yetkilendirmek için taşıyıcı belirteci kullanır ve rastgele bir uygulama adı oluşturur.

Postman'de IoT Central REST öğretici koleksiyonunu açın ve IoT central uygulama isteği oluştur'u seçin.
Gönder'i seçin.
İsteğin başarılı olup olmadığını denetleyin. Başarısız olursa Postman koleksiyonuna bearerToken ve subscriptionId değişken değerlerini girdiğinizi doğrulayın.
Yeni IoT Central uygulamanızın URL'sini görmek için Görselleştir'i seçin. Bu URL'yi not edin, bu öğreticinin ilerleyen bölümlerinde bu URL'ye ihtiyacınız vardır.

Postman'de uygulama URL'sini içeren Görselleştir sekmesini gösteren ekran görüntüsü.

API belirteçleri oluşturma

IoT Central uygulamanızda uygulama API'leri belirteçleri oluşturmak için aşağıdaki veri düzlemi isteklerini kullanın. Bu öğreticideki isteklerden bazıları yönetici izinlerine sahip bir API belirteci gerektirir, ancak çoğu işleç izinlerini kullanabilir:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Operatör belirteci oluşturma isteğini seçin.
Gönder'i seçin.
Postman'de IoT Central REST öğretici koleksiyonunu açın ve Yönetici belirteci oluşturma isteğini seçin.
Gönder'i seçin.

Bu belirteçleri IoT central uygulamanızda görmek istiyorsanız uygulamayı açın ve Güvenlik > İzinleri API belirteçleri'ne >gidin.

Not

Postman'deki bir betik, bu API belirteçlerini sizin için koleksiyon değişkenleri listesine otomatik olarak ekler.

Cihaz kaydetme

Bir cihazın bağlanabilmesi için önce IoT Central'a kaydetmeniz gerekir. Cihazınızı uygulamanıza kaydetmek ve cihaz kimlik bilgilerini almak için aşağıdaki istekleri kullanın. İlk istek, cihaz kimliği olarak phone-001 ile bir cihaz oluşturur:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Cihaz ekle isteğini seçin.
Gönder'i seçin. Yanıtta cihazın sağlanmamış olduğuna dikkat edin.
Postman'de IoT Central REST öğretici koleksiyonunu açın ve Cihaz kimlik bilgilerini al isteğini seçin.
Gönder'i seçin.
Görselleştir sekmesi, cihazın bağlanabilmesi için gereken Kimlik Kapsamı ve Birincil anahtar değerlerini gösterir.

Cihaz sağlama ve bağlama

Akıllı telefonunuzda cihaz kimlik bilgilerini el ile girme gereğini önlemek için IoT central tarafından oluşturulan bir QR kodunu kullanabilirsiniz. QR kodu cihaz kimliğini, kimlik kapsamını ve birincil anahtarı kodlar. QR kodunu görüntülemek için:

Daha önce not aldığınız uygulama URL'sini kullanarak IoT central uygulamanızı açın.
IoT Central uygulamanızda Cihazlar > Telefonum uygulamasıNA > BAĞLAN > QR kodu'na gidin. Cihaz bağlanana kadar bu sayfayı açık tutun.

Cihazı bağlamak için kullandığınız QR kodunu gösteren ekran görüntüsü.

Kurulumu basitleştirmek için bu makalede ioT cihazı olarak IoT Tak Çalıştır akıllı telefon uygulaması kullanılır. Uygulama akıllı telefonun algılayıcılarından toplanan telemetri verilerini gönderir, IoT Central'dan çağrılan komutlara yanıt verir ve özellik değerlerini IoT Central'a raporlar.

Uygulamayı uygulama mağazalarından birinden akıllı telefonunuza yükleyin:

IoT Tak Çalıştır uygulamasını Iot Central uygulamanıza bağlamak için:

Akıllı telefonunuzda IoT PnP uygulamasını açın.
Hoş geldiniz sayfasında QR kodunu tara'yı seçin. Akıllı telefonun kamerasını QR koduna doğrultun. Ardından bağlantı kurulurken birkaç saniye bekleyin.
Uygulamanın telemetri sayfasında, uygulamanın IoT Central'a gönderdiği verileri görebilirsiniz. Günlükler sayfasında, cihazın bağlanıyor ve birkaç başlatma iletisi görebilirsiniz.

Cihazın artık sağlandığından emin olmak için REST API'sini kullanabilirsiniz:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Cihaz isteği al'ı seçin.
Gönder'i seçin. Yanıtta, cihazın artık sağlandığına dikkat edin. IoT Central, cihaz tarafından gönderilen model kimliğine göre cihaza bir cihaz şablonu da atadı.

Uygulamadaki cihaz şablonlarını yönetmek için REST API'yi kullanabilirsiniz. Örneğin, uygulamadaki cihaz şablonlarını görüntülemek için:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Cihaz şablonlarını listeleme isteğini seçin.
Gönder'i seçin.

Cihazı sorgulama ve denetleme

Cihazlarınızdan telemetri sorgulamak için REST API'yi kullanabilirsiniz. Aşağıdaki istek, belirli bir cihaz şablonu kimliğini paylaşan tüm cihazlardan ivmeölçer verilerini döndürür:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Sorgu isteği çalıştır'ı seçin.
Gönder'i seçin.

Cihaz özelliklerini okumak ve ayarlamak için REST API'yi kullanabilirsiniz. Aşağıdaki istek, cihazın uyguladığı Cihaz Bilgileri bileşeninden tüm özellik değerlerini döndürür:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Bir bileşen isteğinden özellikleri al'ı seçin.
Gönder'i seçin.

Cihaz komutlarını çağırmak için REST API'yi kullanabilirsiniz. Aşağıdaki istek, akıllı telefonunuzun ışığını üç saniye boyunca iki kez etkinleştiren bir komut çağırır. Komutun çalışması için akıllı telefonunuzun ekranının IoT Tak Çalıştır uygulamasının görünür olması gerekir:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Çağır komut isteğini seçin.
Gönder'i seçin.

Telemetriyi dışarı aktarma

IoT Central uygulamanızı yapılandırmak ve yönetmek için REST API'yi kullanabilirsiniz. Aşağıdaki adımlarda, bir web kancasına telemetri değerleri göndermek için veri dışarı aktarmayı yapılandırma adımları gösterilmektedir. Kurulumu basitleştirmek için bu makalede hedef olarak RequestBin web kancası kullanılır. RequestBin , Microsoft dışı bir hizmettir.

Veri dışarı aktarma hedefi için test uç noktanızı oluşturmak için:

RequestBin'e gidin.
RequestBin Oluştur'u seçin.
Kullanılabilir yöntemlerden biriyle oturum açın.
RequestBin uç noktanızın URL'sini kopyalayın.
Postman'de IoT Central REST öğretici koleksiyonunu açın ve koleksiyon değişkenlerine gidin.
RequestBin uç noktanızın URL'sini koleksiyon değişkenlerinde webHookURL için Geçerli değer sütununa yapıştırın.
Değişiklikleri kaydedin.

REST API kullanarak IoT Central uygulamanızdaki dışarı aktarma hedefini yapılandırmak için:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Web kancası dışarı aktarma hedef isteği oluştur'u seçin.
Gönder'i seçin.

REST API kullanarak IoT Central uygulamanızda dışarı aktarma tanımını yapılandırmak için:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Telemetri dışarı aktarma tanımı oluşturma isteğini seçin.
Gönder'i seçin. Durumun Başlatılmadığını fark edin.

Dışarı aktarma işleminin başlaması birkaç dakika sürebilir. REST API kullanarak dışarı aktarmanın durumunu denetlemek için:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve Kimliğe göre dışarı aktarma isteği al'ı seçin.
Gönder'i seçin. Durum iyi olduğunda, IoT Central web kancanıza telemetri gönderir.

Akıllı telefonunuzdaki uygulama, ekran açık ve IoT Tak Çalıştır uygulama görünmüyorsa telemetri göndermez.

Akıllı telefon uygulamanız telemetri gönderirken, dışarı aktarılan telemetriyi görüntülemek için RequestBin'inize gidin.

Kaynakları temizleme

Bu öğreticide kullandığınız IoT Central uygulamasını tamamladıysanız REST API'yi kullanarak bu uygulamayı silebilirsiniz:

Postman'de IoT Central REST öğretici koleksiyonunu açın ve IoT central uygulama isteğini sil'i seçin.
Gönder'i seçin.

İpucu

Bu istek, öğreticinin başında oluşturduğunuz taşıyıcı belirteci kullanır. Taşıyıcı belirteçlerin süresi bir saat sonra dolar. erişimine https://apps.azureiotcentral.comyetki veren yeni bir taşıyıcı belirteci oluşturmanız gerekebilir.

Sonraki adımlar

IoT Central öğreticileri kümesine devam etmek ve IoT Central çözümü oluşturma hakkında daha fazla bilgi edinmek isterseniz bkz:

Ağ geçidi cihaz şablonu oluşturma

Aracılığıyla paylaş