BOSE Work Rest API Uygulaması Kullanıcı Kılavuzu

 BOSE Work Rest API Uygulaması

giriiş

Bose Videobar cihazları, ağ yönetimi ve izleme için temsili durum aktarımı uygulama programlama arayüzünü (REST API) destekler. Bu kılavuz, Videobar cihazlarında REST API'yi etkinleştirmek ve yapılandırmak için talimatlar sağlar ve desteklenen değişkenler ve işlemler hakkında ayrıntılı bir açıklama sağlar.
Yapılandırma öğeleri ve işlemler şu kategorilerde gruplandırılmıştır:

• sistem
• davranış
• USB
• ses
• kamera
• ses çerçeveleme
• Bluetooth
• ağ (VBl)
• Wifi
• telemetri (VBl)

API Komut Başvurusu bölümü, her nesne için aşağıdaki bilgileri sağlar:

• Ad/Açıklama Nesnenin adı ve kullanımının açıklaması.
• Eylemler Nesne üzerinde gerçekleştirilebilecek eylemler. Eylem olabilir
• şunlardan biri veya birkaçı olun: al, koy, sil, gönder.
• Değer Aralığı Nesne için kabul edilebilir değerler.
• Varsayılan Değer Nesnenin varsayılan değeri. Bu, cihazı fabrika varsayılanlarına döndürürseniz kullanılan değerdir.
  Tüm değerler dize olarak belirtilir.

Ticari Marka Bildirimleri

• Bose, Bose Work ve Videobar, Bose Corporation'ın ticari markalarıdır.
• Bluetooth” kelime işareti ve logoları, Bluetooth SIG, Inc.'e ait tescilli ticari markalardır ve bu tür markaların Bose Corporation tarafından her türlü kullanımı lisanslıdır.
• HDMI terimi, HDMI Licensing Administrator, Inc.'nin ticari markası veya tescilli ticari markasıdır.
• Diğer tüm ticari markalar ilgili sahiplerinin mülkiyetindedir.

Gizlilik Bilgileri

Gizliliğiniz Bose için önemlidir, bu nedenle kişisel bilgilerinizi nasıl topladığımızı, kullandığımızı, ifşa ettiğimizi, aktardığımızı ve sakladığımızı kapsayan bir Gizlilik Politikası geliştirdik.
BİLGİLERİNİZİ NASIL KULLANDIĞIMIZI ANLAMAK İÇİN LÜTFEN BU GİZLİLİK POLİTİKASINI DİKKATLİCE OKUYUN. BU GİZLİLİK POLİTİKASINI KABUL ETMİYORSANIZ, LÜTFEN HİZMETLERİ KULLANMAYIN.

REST API'yi Etkinleştirme ve Yapılandırma

Bir cihazda REST API'ye erişimi etkinleştirmek için Bose Work Configuration uygulamasını, Bose Work Management uygulamasını veya Web kullanıcı arayüzü Ağ> API ayarlarına erişin. API erişimini etkinleştirin ve bir API kullanıcı adı ve şifresi belirleyin. REST API komutlarından herhangi birini kullanmak için bu API kimlik bilgilerine ihtiyacınız olacak. Daha fazla bilgi için lütfen uygulama kullanım kılavuzlarına başvurun.

REST API'sini test etme

Cihaza gömülü Swagger OpenAPI arayüzünü kullanarak Videobar REST API'sini test edebilirsiniz. Bu arayüze erişmek için Videobar'ın kablolu veya WiFi arayüzü aracılığıyla bir IP ağına bağlı olması ve ana bilgisayarınızın aynı ağda veya HTTPS yoluyla cihaza erişebilen bir ağda olması gerekir.
PC'nizi USB arabirimi aracılığıyla Videobar'a bağlayın. Bose Work Configuration uygulamasını başlatın ve yönetici kontrollerine erişmek için oturum açın. Ağ > API sayfasını seçin ve şu bağlantıya tıklayın:
REST API Belgeleri (Web UI)
Cihaza USB üzerinden bağlı değilseniz ve PC'niz aynı ağ üzerindeyse, aşağıdaki adrese göz atarak tarayıcınız üzerinden REST API'ye erişebilirsiniz:
https://<videobar-ip-address>/doc-api

REST API Komutları

Videobar REST API arayüzü, desteklenen dört HTTP yönteminin her birinde komut kimliklerini kullanır: al, koy, sil ve gönder.
Aşağıda dört yöntemin açıklaması ve ardından her bir komut için desteklenen yöntemleri açıklayan bir tablo bulunmaktadır.

ELDE ETMEK

"get" yöntemi, tek bir komut kimliğini veya birden çok virgülle ayrılmış kimliği kabul eder. eski içinample, audio.micMute durumunu almak için komut kimliği 2'dir. URL şöyle:
https://192.168.1.40/api?query=2  

Yanıt gövdesi, mikrofonun sessize alınmadığını gösteren "O" değeriyle aşağıdaki gibidir:
{“2”: {“durum”: “başarı”, “değer”: “0”}}

Birden çok değeri sorgulamak için birden çok komut kimliğini virgülle ayırın. eski içinample, bunun gibi audio.micMute (ID=2) ve system.firmwareVersion (ID=l6) için sorgu yapabilirsiniz:
https://192.168.1.40/api?query=2,16 

Not: Birden çok kimlik arasına boşluk eklemeyin.
Sonuç şöyle olurdu:
{"2": {"durum": "başarılı", "değer": "0"}, "16": {"durum": "başarılı", "değer": "1.2.13_fd6cc0e"}}

KOYMAK

Bir "put" komutu, anahtarın "veri" olduğu ve değerin ID:değer çiftleri olduğu bir JSON gövde biçimini kullanır.
Örneğinample, audio.loudspeakerVolume (ID=3) değerini 39 olarak ayarlamak için “https://192.168.1.40/api” gövdesi:
{“veri”:”{“3″:”39″}”}

Cevap:
{“3”: {“durum”: “başarı”, “kod”: “0xe000”}}

İşte bir eskiample birden çok değer ayarlama:
{“veri”:”{“2″:”1″,”3″:”70″}”}

Cevap:
{"2": {"durum": "başarılı", "kod": "0xe000"}, "3": {"durum": "başarılı", "kod": "0xe000"}}

Yanıt "kodu" değerleri aşağıdakilerden herhangi biri olabilir:

• 0xe000 : Başarı
• 0xe001 : Başarı – Değerde değişiklik yok
• 0xe002 : Hata – Geçersiz özellik
• 0xe003 : Hata – Geçersiz özellik değeri
• 0xe004: Hata – Geçersiz özellik eylemi
• 0xe005 : Hata – Mesaj hatalı biçimlendirilmiş
• 0xe006: Hata – Erişim reddedildi

POSTALAMAK

"Gönder", "koy"a benzer ve mikrofon sesini kapatma ve hoparlör sesini artırma/azaltma gibi eylemler için kullanılır. Komut kimliğini belirtirsiniz ve değer için boş bir dize kullanırsınız.
Örneğinample, hoparlör sesini bir tık artırmak için, gövde biçimi şu şekilde olan audio.loudspeakerVolumeUp (ID=4) kullanın:
{“veri”:”{“4″:””}”}

Yanıt gövdesi:
{“4”: {“durum”: “başarı”, “kod”: “0xe000”}}
Olası yanıt “kodu” değerleri, PUT komutu için listelenenlerle aynıdır.

SİLMEK

“Sil” komut formatı “get” ile benzerdir ve yanıt gövdesi “put” ile benzerdir. Sil'i kullanmak, değeri varsayılan değerine geri döndürür.
Örneğinample, audio.loudspeaker ses düzeyini (ID=3) varsayılan değerine ayarlamak için, URL şöyle:
https://192.168.1.40/api?delete=3 

Yanıt gövdesi: 
{“3”: {“durum”: “başarı”, “kod”: “0xe000”}}

Bu durumda 50 olan yeni değeri almak için bir "get" düzenlemeniz gerekir.amptarih:
Emretmek:
https://192.168.1.40/api?query=3

Cevap: 
{“3”: {“durum”: “başarı”, “değer”: “50”}}
Olası yanıt “kodu” değerleri, PUT komutu için listelenenlerle aynıdır.

Videobar REST API Komut Referansı