Puntos finales de información de rDWS

9 min

url base para estos endpoints https //ws bsn cloud/rest/v1/ get /info/ recupera información general sobre el reproductor ejemplo de solicitud get /rest/v1/info/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json respuesta serie \string\ el número de serie del reproductor modelo \string\ el número de modelo del dispositivo (p ej , "xd234") tipo de conexión \string\ la interfaz de red actualmente activa, que puede ser "ethernet" o "wifi" ethernet \object\ un objeto que contiene información sobre la conexión ethernet esta propiedad solo estará disponible si hay una conexión ethernet válida en el reproductor el objeto puede contener las siguientes propiedades ipv4 \object\ un objeto que contiene información sobre la configuración ipv4 el objeto puede contener las siguientes propiedades dirección \string\ la dirección ipv4 asignada máscara de red \string\ la máscara de red ipv4 familia \string\ ipv4 mac \string\ la dirección mac de la interfaz de red interno \bool\ verdadero si la interfaz de red es una interfaz loopback o similar a la que no se puede acceder remotamente; de lo contrario falso cidr \string\ la dirección ipv4 asignada con el prefijo de enrutamiento en notación cidr si la máscara de red no es válida, esta propiedad se establece en null ipv6 \object\ un objeto que contiene información sobre la configuración ipv6 dirección \string\ la dirección ipv6 asignada máscara de red \string\ la máscara de red ipv6 familia \string\ ipv6 mac \string\ la dirección mac de la interfaz de red interno \bool\ verdadero si la interfaz de red es una interfaz loopback o similar a la que no se puede acceder remotamente; de lo contrario falso cidr \string\ la dirección ipv4 asignada con el prefijo de enrutamiento en notación cidr si la máscara de red no es válida, esta propiedad se establece en null bootversion \string\ la versión actual del cargador de arranque fwversion \string\ la versión actual del firmware instalado en el reproductor uptime \string\ la cantidad de tiempo (como una cadena legible para humanos) durante la cual el reproductor ha estado encendido y funcionando correctamente uptimeseconds \int\ la cantidad de tiempo (en segundos) durante la cual el reproductor ha estado encendido y funcionando correctamente extensiones \extension\[ ]\ un arreglo de objetos extension que describen las firmware extensions actualmente instaladas en el reproductor bendiciones \blessing\[ ]\ un arreglo de objetos blessing que describen los códecs propietarios que actualmente están autorizados en el reproductor ejemplo de respuesta { "route" "/v1/info", "method" "get", "data" { "result" { "serial" "re433d006644", "uptime" "30 minutes", "uptimeseconds" 1832, "model" "xd1035", "fwversion" "9 0 97", "bootversion" "9 0 85", "family" "cobra", "isplayer" true, "power" { "result" { "battery" "absent", "source" "ac", "switch mode" "hard" } }, "poe" { "result" { "status" "inactive" } }, "extensions" { "result" { "extensions" \[] } }, "blessings" { "result" { "ac3" false, "eac3" false } }, "networking" { "result" { "description" "test player", "name" "xd5 re433d006644" } }, "bvnpipelines" { "result" { "pipelines" \[] } }, "bvncomponents" { "result" { "components" \[] } }, "hardware features" { "hdmi" true, "component video" false, "vga" false, "two channel audio" true, "ethernet" true, "usb" true, "serial port 0" true, "serial port 1" false, "gpio connector" true, "svc button" true, "reset button" true, "rtc" true, "settings rom" false, "microsd" false, "sdhc" true, "six channel audio" false, "ir blaster" true, "wifi" false, "serial port 2" false, "audio input" false, "cec" true, "battery" false, "portrait lcd" false, "hdmi input" false, "digital tuner" false, "spdif" true, "audio input loopback" false, "msata" false, "ac3" false, "eac3" false, "onboard storage" true, "no 4k decode" false, "no bluetooth" false, "no poe" false, "internal storage only" false, "disable packet capture" false, "disable bsn cloud" false, "brightear" false, "disable dws" false }, "api features" { "video" true }, "active features" { "legacydws" true }, "connectiontype" "eth0", "ethernet" \[ { "interfacename" "eth0", "interfacetype" "ethernet", "ipv4" \[ { "address" "123 456 7 890", "netmask" "255 255 255 0", "family" "ipv4", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "192 168 1 174/24" } ], "ipv6" \[ { "address" "2600 1700\ dac0 2060 23", "netmask" "ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 23/128", "scopeid" 0 }, { "address" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64", "scopeid" 0 }, { "address" "fe80 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "fe80 92ac 3fff\ fe2a 179/64", "scopeid" 2 } ] } ], "wireless" \[], "interfaces" \[], "bsnce" true } } } get /time/ recupera la fecha y la hora configuradas en el reproductor el valor de fecha/hora tiene el formato "yyyy mm dd hh\ mm\ ss \<timezone>" esta llamada es idéntica al uso de la api time de node js® ejemplo de solicitud get /rest/v1/time/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json ejemplo de respuesta { "route" "/v1/time", "method" "get", "data" { "result" { "time" "2018 10 18 14 34 34 pdt", "timezone mins" null, "timezone name" "america/los angeles", "timezone abbr" "pdt", "year" 2018, "month" 10, "date" 18, "hour" 14, "minute" 34, "second" 34, "millisecond" 569 } } } put /time/ establece la fecha/hora en el reproductor cuerpo de la solicitud tiempo \string\ la hora que se establecerá en el reproductor, con el formato "hh\ mm\ ss \<zona horaria>" fecha \string\ la fecha que se establecerá en el reproductor, con el formato "aaaa mm dd" applytimezone \bool\ una marca que especifica si la fecha y la hora deben aplicarse utilizando la zona horaria configurada en el reproductor ( verdadero ) o la zona horaria utc ( falso ) ejemplo de solicitud put /rest/v1/time/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 117 este es el cuerpo de la solicitud de ejemplo { "data" { "time" "22 00 00", "date" "2023 11 07", "applytimezone" true } } ejemplo de respuesta una respuesta correcta tendría un código de estado \200\ con el siguiente cuerpo { "data" { "result" true } } get /health/ recupera el estado actual del reproductor actualmente, este endpoint solo se utiliza para determinar si un reproductor puede responder a una solicitud de websockets; no puede determinar el estado de error de un reproductor ejemplo de solicitud get /rest/v1/health/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta estado \string\ el estado del reproductor el único valor posible es "active" statustime \string\ la fecha y la hora en que el reproductor respondió a la solicitud de estado la fecha/hora tiene el formato "yyyy mm dd hh\ mm\ ss \<timezone>" ejemplo de respuesta { "route" "/v1/health", "method" "get", "data" { "result" { "status" "active", "statustime" "2024 01 30 07 38 05 pst" } } }