BOSE Work Rest API aplikazioaren erabiltzailearen gida

 BOSE Work Rest API aplikazioa

Sarrera

Bose Videobar gailuek irudikapen egoera transferitzeko aplikazioen programazio interfazea (REST API) onartzen dute sarearen kudeaketa eta jarraipena egiteko. Gida honek REST APIa Videobar gailuetan gaitzeko eta konfiguratzeko argibideak eskaintzen ditu, eta onartzen diren aldagaien eta eragiketen deskribapen zehatza eskaintzen du.
Konfigurazio-elementuak eta eragiketak kategoria hauetan multzokatzen dira:

• sistema
• portaera
• usb
• audioa
• kamera
• audioframing
• bluetooth
• sarea (VBl)
• wifia
• telemetria (VBl)

API komandoen erreferentzia atalak informazio hau eskaintzen du objektu bakoitzarentzat:

• Izena/Deskribapena Objektuaren izena eta erabileraren deskribapena.
• Ekintzak Objektuan egin daitezkeen ekintzak. Ekintzak egin dezake
• izan hauetako bat edo gehiago: lortu, jarri, ezabatu, argitaratu.
• Balio sorta Objekturako balio onargarriak.
• Balio lehenetsia Objektuaren balio lehenetsia. Hau da gailua fabrikako lehenetsietara itzultzen baduzu erabiltzen den balioa.
  Balio guztiak kate gisa zehazten dira.

Marken oharrak

• Bose, Bose Work eta Videobar Bose Corporation-en marka komertzialak dira.
• Bluetooth” hitz-marka eta logotipoak Bluetooth SIG, Inc.-ren jabetzako marka komertzialak dira eta Bose Corporation-ek marka horien erabilera lizentziapean dago.
• HDMI terminoa HDMI Licensing Administrator, Inc-ren marka komertziala edo erregistratua da.
• Gainerako marka guztiak dagozkien jabeen jabetzakoak dira.

Pribatutasun informazioa

Zure pribatutasuna garrantzitsua da Boserentzat, beraz, Pribatutasun-politika bat garatu dugu, zure informazio pertsonala nola biltzen, erabiltzen, ezagutarazten, transferitzen eta gordetzen dugun jasotzen duena.
MESEDEZ, IRAKURRI ARRETA PRIBATUTASUN POLITIKA HAU ZURE INFORMAZIOA NOLA KUDEATZEN DUGUN ULERTZEKO. PRIBATUTASUN POLITIKA HAU ONARTZEN EZ BAZAZU, MESEDEZ EZ ERABILI ZERBITZUAK.

REST APIa gaitzea eta konfiguratzea

Gailu batean REST APIrako sarbidea gaitzeko, erabili Bose Work Configuration aplikazioa, Bose Work Management aplikazioa edo Web UI. Sartu Sarea> API ezarpenetara. Gaitu API sarbidea eta zehaztu API erabiltzaile-izena eta pasahitza. API kredentzial hauek beharko dituzu REST API komandoetako edozein erabiltzeko. Mesedez, kontsultatu aplikazioaren erabiltzailearen gidak informazio gehiago lortzeko.

REST APIa probatzen

Videobar REST APIa probatu dezakezu gailuan txertatuta dagoen Swagger OpenAPI interfazea erabiliz. Interfaze honetara sartzeko Bideo-barra IP sare batera konektatuta egon behar da bere kable bidez edo WiFi interfazearen bidez, eta zure ordenagailu ostalariaren sare berean egon behar du edo gailura HTTPS bidez sar daitekeen sare batean.
Konektatu ordenagailua bideo-barrara USB interfazearen bidez. Hasi Bose Work Configuration aplikazioa eta hasi saioa administrazio-kontroletara sartzeko. Aukeratu Sarea > API orria eta egin klik estekan:
REST APIaren dokumentazioa (Web UI)
Ez bazaude gailura USB bidez konektatuta eta zure ordenagailua sare berean badago, zure arakatzailearen bidez REST APIra sar zaitezke helbide honetara arakatuta:
https://<videobar-ip-address>/doc-api

REST API komandoak

Videobar REST API interfazeak komandoen IDak erabiltzen ditu onartzen diren lau HTTP metodoetako bakoitzean: lortu, jarri, ezabatu eta argitaratu.
Jarraian, lau metodoen deskribapena dago eta, ondoren, komando bakoitzak onartzen dituen metodoak deskribatzen dituen taula.

LORTU

"Lortu" metodoak komando ID bakarra edo komaz mugatutako ID anitz onartzen ditu. Adibidezample, audio.micMute egoera lortzeko, komandoaren IDa 2 da URL honela da:
https://192.168.1.40/api?query=2  

Erantzunaren gorputza honako hau da, "O" balioarekin mikrofonoa isilduta ez dagoela adierazten duena:
{“2”: {“egoera”: “arrakasta”, “balioa”: “0”}}

Hainbat balio kontsultatzeko, bereizi hainbat komando ID koma batekin. Adibidezample, audio.micMute (ID=2) eta system.firmwareVersion (ID=l6) kontsulta ditzakezu honela:
https://192.168.1.40/api?query=2,16 

Oharra: ez sartu tarterik ID anitzen artean.
Emaitza hau izango litzateke:
{“2”: {“egoera”: “arrakasta”, “balioa”: “0”}, “16”: {“egoera”: “arrakasta”, “balioa”: “1.2.13_fd6cc0e”}}

JARRI

"Jarri" komando batek JSON gorputz formatua erabiltzen du, gakoa "datuak" izanik eta balioa ID:balio bikoteak izanik.
Adibidezample, audio.loudspeakerVolume (ID=3) 39an ezartzeko, "https://192.168.1.40/ api" gorputza hau da:
{“datuak”:”{“3″:”39″}”}

Erantzuna hau da:
{“3”: {“egoera”: “arrakasta”, “kodea”: “0xe000”}}

Hona hemen exampbalio anitzak ezartzen dituen fitxategia:
{“datuak”:”{“2″:”1″,”3″:”70″}”}

Erantzuna hau da:
{“2”: {“egoera”: “arrakasta”, “kodea”: “0xe000”}, “3”: {“egoera”: “arrakasta”, “kodea”: “0xe000”}}

Erantzun "kode" balioak hauetako edozein izan daitezke:

• 0xe000 : Arrakasta
• 0xe001 : Arrakasta - Ez dago balio aldaketarik
• 0xe002: Errorea - Propietate baliogabea
• 0xe003: Errorea - Propietatearen balio baliogabea
• 0xe004: Errorea - Jabetza-ekintza baliogabea
• 0xe005: Errorea - Mezua gaizki osatuta
• 0xe006: Errorea - Sarbidea ukatu da

POST

"Argitalpena" "jarri"-ren antzekoa da eta ekintzetarako erabiltzen da, esate baterako, mikrofonoa desaktibatu eta bozgorailuaren bolumena gora/behera. Komandoaren IDa zehazten duzu eta baliorako kate huts bat erabiltzen duzu.
Adibidezample, bozgorailuaren bolumena tick bat handitzeko, erabili audio.loudspeakerVolumeUp (ID=4) gorputz formatuan honela:
{“datuak”:”{“4″:””}”}

Erantzunaren gorputza hau da:
{“4”: {“egoera”: “arrakasta”, “kodea”: “0xe000”}}
Erantzun posibleen "kode" balioak PUT komandorako zerrendatutako berberak dira.

EZABATU

"Ezabatu" komando formatua "lortu"-ren antzekoa da eta erantzunaren gorputza "jarri"-ren antzekoa da. Ezabatu erabiliz gero, balioa lehenespenera itzuliko da.
Adibidezample, audio.bozgorailuaren bolumena (ID=3) bere balio lehenetsian ezartzeko URL honela da:
https://192.168.1.40/api?delete=3 

Erantzunaren gorputza hau da: 
{“3”: {“egoera”: “arrakasta”, “kodea”: “0xe000”}}

"Lortu" bat igorri beharko zenuke balio berria berreskuratzeko, hau da, kasu honetan 50. Adibidezample:
Agindua:
https://192.168.1.40/api?query=3

Erantzuna: 
{“3”: {“egoera”: “arrakasta”, “balioa”: “50”}}
Erantzun posibleen "kode" balioak PUT komandorako zerrendatutako berberak dira

Videobar REST API komandoen erreferentzia