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. Esto también se puede hacer en la pestaña local DWS Diagnostics.

Segmento

device_name string: El dispositivo de almacenamiento especificado (consulte roStorageInfo para obtener una lista de dispositivos disponibles)

Cuerpo de la solicitud

fs string: El sistema de archivos 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.

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 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
        }
    }
}