Guida per l'utente dell'app BOSE Work Rest API

 App BOSE Work Rest API

Introduzione

I dispositivi Bose Videobar supportano l'interfaccia di programmazione dell'applicazione di trasferimento dello stato rappresentativo (API REST) ​​per la gestione e il monitoraggio della rete. Questa guida fornisce istruzioni per abilitare e configurare l'API REST sui dispositivi Videobar e fornisce una descrizione dettagliata delle variabili e delle operazioni supportate.
Gli elementi di configurazione e le operazioni sono raggruppati in queste categorie:

• sistema
• comportamento
• USB-C
• audio
• telecamera
• inquadratura audio
• Bluetooth
• rete (VBl)
• Wifi
• telemetria (VBl)

La sezione Riferimento ai comandi API fornisce le seguenti informazioni per ciascun oggetto:

• Nome/Descrizione Nome dell'oggetto e descrizione del suo utilizzo.
• Azioni Azioni che possono essere eseguite sull'oggetto. L'azione può
• essere uno o più dei seguenti: get, put, delete, post.
• Intervallo di valori Valori accettabili per l'oggetto.
• Valore predefinito Valore predefinito dell'oggetto. Questo è il valore utilizzato se si ripristinano le impostazioni di fabbrica del dispositivo.
  Tutti i valori sono specificati come stringhe.

Avvisi sui marchi

• Bose, Bose Work e Videobar sono marchi di Bose Corporation.
• Il marchio denominativo e i loghi Bluetooth” sono marchi registrati di proprietà di Bluetooth SIG, Inc. e qualsiasi utilizzo di tali marchi da parte di Bose Corporation è concesso in licenza.
• Il termine HDMI è un marchio o un marchio registrato di HDMI Licensing Administrator, Inc.
• Tutti gli altri marchi appartengono ai rispettivi proprietari.

Informativa sulla privacy

La tua privacy è importante per Bose, quindi abbiamo sviluppato un'Informativa sulla privacy che copre il modo in cui raccogliamo, utilizziamo, divulghiamo, trasferiamo e archiviamo le tue informazioni personali.
SI PREGA DI LEGGERE ATTENTAMENTE QUESTA POLITICA SULLA PRIVACY PER COMPRENDERE COME GESTIAMO LE VOSTRE INFORMAZIONI. SE NON SI ACCETTA LA PRESENTE POLITICA SULLA PRIVACY, SI PREGA DI NON UTILIZZARE I SERVIZI.

Abilitazione e configurazione dell'API REST

Per abilitare l'accesso all'API REST su un dispositivo, utilizzare l'app Bose Work Configuration, l'app Bose Work Management o il Web interfaccia utente. Accedi a Rete> Impostazioni API. Abilita l'accesso all'API e specifica un nome utente e una password dell'API. Avrai bisogno di queste credenziali API per utilizzare uno qualsiasi dei comandi API REST. Fare riferimento alle guide per l'utente dell'applicazione per ulteriori informazioni.

Test dell'API REST

Puoi testare l'API REST di Videobar utilizzando l'interfaccia Swagger OpenAPI incorporata nel dispositivo. Per accedere a questa interfaccia, la Videobar deve essere collegata a una rete IP tramite la sua interfaccia cablata o Wi-Fi e il tuo PC host deve trovarsi sulla stessa rete o su una rete che può accedere al dispositivo tramite HTTPS.
Collega il tuo PC alla Videobar tramite l'interfaccia USB. Avvia l'app Bose Work Configuration e accedi per accedere ai controlli di amministrazione. Scegli la pagina Rete > API e fai clic sul collegamento:
Documentazione API REST (Web UI)
Se non sei connesso al dispositivo tramite USB e il tuo PC è sulla stessa rete, puoi accedere all'API REST tramite il tuo browser navigando al seguente indirizzo:
https://<videobar-ip-address>/doc-api

Comandi API REST

L'interfaccia dell'API REST di Videobar utilizza gli ID comando in ciascuno dei quattro metodi HTTP supportati: get, put, delete e post.
Di seguito è riportata una descrizione dei quattro metodi seguita da una tabella che descrive i metodi supportati per ciascuno dei comandi.

OTTENERE

Il metodo "get" accetta un singolo ID comando o più ID delimitati da virgole. Per esample, per ottenere lo stato audio.micMute, l'ID del comando è 2. Il URL è come questo:
https://192.168.1.40/api?query=2  

Il corpo della risposta è il seguente, con un valore di "O" che indica che il microfono non è disattivato:
{"2": {"stato": "successo", "valore": "0"}}

Per eseguire query su più valori, separa più ID comando con una virgola. Per esample, potresti eseguire una query per audio.micMute (ID=2) e system.firmwareVersion (ID=l6) in questo modo:
https://192.168.1.40/api?query=2,16 

Nota: non includere spazi tra più ID.
Il risultato sarebbe:
{"2": {"stato": "successo", "valore": "0"}, "16": {"stato": "successo", "valore": "1.2.13_fd6cc0e"}}

METTERE

Un comando "put" utilizza un formato del corpo JSON con la chiave "data" e il valore ID: coppie di valori.
Per esempioample, per impostare audio.loudspeakerVolume (ID=3) su 39, il corpo "https://192.168.1.40/api" è:
{"dati":"{"3″:"39″}"}

La risposta è:
{"3": {"stato": "successo", "codice": "0xe000"}}

Ecco un example impostando più valori:
{"data":"{"2″:"1″",3″:"70″}"}

La risposta è:
{"2": {"stato": "successo", "codice": "0xe000"}, "3": {"stato": "successo", "codice": "0xe000"}}

I valori del "codice" della risposta possono essere uno dei seguenti:

• 0xe000: successo
• 0xe001: Successo – Nessuna modifica del valore
• 0xe002 : Errore – Proprietà non valida
• 0xe003 : Errore – Valore della proprietà non valido
• 0xe004 : Errore – Azione proprietà non valida
• 0xe005 : Errore – Messaggio non valido
• 0xe006 : Errore – Accesso negato

INVIARE

Un "post" è simile a "put" e viene utilizzato per azioni, come attivare/disattivare l'audio del microfono e aumentare/ridurre il volume dell'altoparlante. Specificare l'ID comando e utilizzare una stringa vuota per il valore.
Per esempioample, per aumentare il volume dell'altoparlante di un segno di spunta, utilizzare audio.loudspeakerVolumeUp (ID=4) con il formato del corpo in questo modo:
{"dati":"{"4″:""}"}

Il corpo di risposta è:
{"4": {"stato": "successo", "codice": "0xe000"}}
I possibili valori di “codice” di risposta sono gli stessi elencati per il comando PUT.

ELIMINARE

Il formato del comando "cancella" è simile a "get" e il corpo della risposta è simile a "put". L'utilizzo di delete riporterà il valore al valore predefinito.
Per esempioample, per impostare il volume audio.loudspeaker (ID=3) sul valore predefinito, il URL è come questo:
https://192.168.1.40/api?delete=3 

Il corpo di risposta è: 
{"3": {"stato": "successo", "codice": "0xe000"}}

Dovresti emettere un "get" per recuperare il nuovo valore, che in questo caso è 50. Ad esampon:
Comando:
https://192.168.1.40/api?query=3

Risposta: 
{"3": {"stato": "successo", "valore": "50"}}
I possibili valori di “codice” di risposta sono gli stessi elencati per il comando PUT

Riferimento ai comandi dell'API REST di Videobar