rDWS Otros Endpoints

11 min

url base para estos endpoints https //ws bsn cloud/rest/v1/ delete /storage/{\ device name}/ reformatea el dispositivo de almacenamiento especificado debe deshabilitar la ejecución automática antes de reformatear la tarjeta sd en su dispositivo para deshabilitar la ejecución automática, use put /v1/control/reboot con el parámetro body { “autorun” ”disable” }, como se describe en puntos de control de rdws docid\ ambngjdqleplzzrx49ab4 esto también se puede hacer en la pestaña local dws diagnostics segmento device name \string\ el dispositivo de almacenamiento especificado (consulte rostorageinfo docid\ cq sl6dmkcslnwgvzgoyw para obtener una lista de dispositivos disponibles) cuerpo de la solicitud fs \string\ el sistema de archivos docid 8viubcc3f1mpxoos0i8yf que se utilizará al reformatear un dispositivo de almacenamiento el valor predeterminado de fs es "exfat" ejemplo de solicitud delete /rest/v1/storage/sd/?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 49 este es el cuerpo de solicitud de ejemplo { "data" { "fs" "exfat" } } ejemplo de respuesta { "data" { "result" { "success" true, "output" "format completeted successfully ", "error" "" } }, "route" "/v1/storage/sd", "method" "delete" } get /re provision/ llamar a este endpoint volverá a aprovisionar el reproductor (en otras palabras, se descargará la configuración de b deploy/ provisioning actualmente asociada con el reproductor y el dispositivo volverá a pasar por la configuración) la funcionalidad de la ui de brightsign author que utiliza esta funcionalidad es volver a aprovisionar reproductor docid\ qxt4yhey7iej m9dh73wm el proceso de reaprovisionamiento implica los siguientes pasos si la sección “networking” del registro del reproductor contiene los tokens de acceso y actualización, se asume que el reproductor se configuró previamente para bsn cloud por lo tanto, brightsign conserva algunas claves relacionadas con la configuración en la sección networking (consulte "setup related keys" a continuación) y elimina el resto de entradas del registro si la sección networking no incluye tokens de acceso y actualización, vaciará toda la sección networking, formateará la tarjeta sd y reiniciará para intentar aprovisionar el reproductor brightsign también establece el parámetro “devicesetupcomplete“ en la sección “autorun” en null para que el reproductor pueda configurarse nuevamente esta clave se establece en 1 solo si el reproductor se configuró previamente mediante la opción de configuración en el dispositivo el código elimina todos los archivos del dispositivo de almacenamiento predeterminado (casi siempre es la tarjeta sd) no necesita formatear el almacenamiento por separado el reproductor se reinicia, obtiene el paquete de configuración de b deploy y vuelve a aprovisionarse claves relacionadas con la configuración \ inp (inherit network properties) \ networkjson (network settings in json format setup version v3) \ modem json (default settings for modem configuration in json format) \ wifi (use wireless) \ ss (wifi ssid) \ pp (wifi passphrase) the first network interface, either ethernet or wifi \ dhcp (use dhcp) \ sip (static ip address) \ sm (subnet mask) \ gw (gateway) \ dns1 (first dns) \ dns2 (second dns) \ dns3 (third dns) the second network interface, either ethernet or wifi \ dhcp2 \ sip2 \ sm2 \ gw2 \ dns12 \ dns22 \ dns32 \ ncp (wired connection priority) \ ncp2 (wireless connection priority) \ up (use proxy) \ ps (proxy server url) \ bph (proxy bypass list) \ ts (time servers list) rate limits for the first network interface, ethernet or wifi \ rlmid (rate limit mode during initial downloads) \ rlrid (rate limit value during initial downloads) \ rlmow (rate limit mode outside download window) \ rlrow (rate limit value outside download window) \ rlmiw (rate limit mode inside download window) \ rlriw (rate limit value inside download window) rate limits for the second network interface, ethernet or wifi \ rlmid2 \ rlrid2 \ rlmow2 \ rlrow2 \ rlmiw2 \ rlriw2 enabled flag values for the ethernet interface \ cwr (content transfers enabled) \ twr (text feed transfers enabled) \ mwr (media feed transfers enabled) \ hwr (health transfers enabled) \ lwr (log upload transfers enabled) enabled flag values for the wifi interface \ cwf \ twf \ mwf \ hwf \ lwf if vlanids = 25 \ usedhcp vlan 25 \ staticipaddress vlan 25 \ subnetmask vlan 25 \ gateway vlan 25 \ dns1 vlan 25 \ dns2 vlan 25 \ dns3 vlan 25 ejemplo de solicitud get /rest/v1/re provision/?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 éxito \bool\ verdadero significa que la operación se realizó correctamente y el reproductor se reiniciará falso significa que la operación falló ejemplo de respuesta { "route" "/v1/re provision", "method" "get", "data" { "result" { "success" true } } } post /snapshot/ toma una captura de pantalla del contenido actual de la pantalla y la guarda en el almacenamiento consulte formato del mensaje de solicitud docid\ fy7ynorkjn664uxdkkwjn para conocer los parámetros de la cadena de consulta ejemplo de solicitud post /rest/v1/snapshot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} cuerpo de la respuesta remotesnapshotthumbnail \string\ una miniatura de la imagen de la captura en formato base64 nombre de archivo \string\ el nombre y la ruta del archivo de imagen de la captura llame a get /file/{\ path} para recuperar la imagen en resolución completa marca de tiempo \string\ la fecha y hora en que se tomó la captura la fecha/hora tiene el formato " yyyy mm dd hh\ mm\ ss \<zona horaria>" " ejemplo de respuesta { "route" "/v1/snapshot", "method" "post", "data" { "result" { "remotesnapshotthumbnail" "data\ image/jpeg;base64,/9j/4aaqskzjrgabaqaaaqabaad/4qderxhpzgaasukqaagaaaabagmhbaabaaaaggaaaaaaaaakaa8bagalaaaataaaababagahaaaawaaaadebagaiaaaaraaaadibagauaaaamaaaadsbaganaaaayaaaacqicaabaaaagi8aaacqbwaeaaaamdixmaggawabaaaaaqaaaakgbaabaaaagacaaaogbaabaaaaoaqaaaaaaaaymdi0ojayoja3idexojm2ojmwahy5ljauotcaqnjpz2h0u2lnbgaaweqxmdm1aabnneuzm0qwmdy4mjqaap/baiqaaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqebaqeb/8aaeqgauab4aweraairaqmraf/eaaiaaaefaqebaqebaaaaaaaaaaabagmebqyhcakkcxaaagedawieawufbaqaaaf9aqidaaqrbrihmuege1fhbyjxfdkbkaeii0kxwrvs0fakm2jyggkkfhcygroljicokso0nty3odk6q0rfrkdisuptvfvwv1hzwmnkzwznaglqc3r1dnd4exqdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2uhi4+tl5ufo6erx8vp09fb3+pn6aqadaqebaqebaqebaaaaaaaaaqidbaugbwgjcgsraaibagqeawqhbqqeaaecdwabagmrbauhmqysqvehyxetijkbcbrckagxwqkjm1lwfwjy0qowjdthjfexgbkajicokso1njc4otpdrevgr0hjslnuvvzxwflay2rlzmdoawpzdhv2d3h5eokdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2ulj5oxm5+jp6vlz9px29/j5+v/aaawdaqaceqmrad8a/e+v9wd+4aoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakacgaoakap8a/9k=", "filename" "/sd/remote snapshots/img 2024 02 07 11 36 30 jpg", "timestamp" "2024 02 07 11 36 33 pst", "devicename" "xd5 re433d006644", "width" 1920, "height" 1080 } } } put /custom/ envía datos personalizados al reproductor el reproductor a su vez envía los datos como un mensaje (en formato de cadena json) en el puerto udp 5000, que luego puede ser capturado por la aplicación autorun brs o una aplicación javascript en el reproductor cuerpo de la solicitud comando \string\ los datos personalizados que se enviarán returnimmediately \bool\ un indicador que especifica si el servidor debe responder a la solicitud put inmediatamente ( verdadero ) o esperar una respuesta al mensaje udp de la aplicación brightscript/javascript ( falso ) ejemplo de solicitud put /rest/v1/custom/?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 89 este es el cuerpo de solicitud de ejemplo { "data" { "command" "next", "returnimmediately" true } } cuerpo de la respuesta si la propiedad returnimmediately es verdadero , el servidor devolverá un mensaje de éxito o error si la propiedad es falso , el servidor esperará una respuesta del puerto udp 5000 en el reproductor y la enviará como respuesta a la solicitud put ejemplo de respuesta { "data" { "result" { "success" true } }, "route" "/v1/custom", "method" "put" } get /download firmware/ indica al reproductor que descargue y aplique una actualización de firmware parámetro de cadena de consulta url \string\ la url pública para descargar el archivo de actualización de firmware ejemplo de solicitud get /rest/v1/download firmware/?url=https //bsncloud s3 amazonaws com/public/cobra 9 0 110 update bsfw\&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 éxito \bool\ un indicador de si la descarga fue exitosa reiniciar \bool\ un indicador de si el reproductor se reiniciará al aplicar una actualización de firmware ejemplo de respuesta { "route" "/v1/download firmware", "method" "get", "data" { "result" { "success" true, "reboot" true } } }