Puntos de control de rDWS
URL base para estos endpoints: https://ws.bsn.cloud/rest/v1/
_________________________________________________________________________
PUT /control/reboot/
Reinicia el reproductor. El reproductor no enviará una respuesta a una solicitud de reinicio.
Cuerpo de la solicitud
- informe_de_fallo bool: Establecerlo en verdadero reinicia el reproductor y guarda un archivo de informe de bloqueo en la carpeta brightsign-dumps. Debe usar esto solo cuando el servicio de atención al cliente de BrightSign se lo indique, ya que puede necesitar el informe de bloqueo para ayudarle a solucionar problemas de un reproductor.
- factory_reset bool: Establecerlo en verdadero restablece el reproductor a los valores predeterminados de fábrica, borrando todas las configuraciones persistentes del registro para redes, seguridad y otras aplicaciones.
- autorun string: Establecerlo en desactivar deshabilita el script autorun actual (esto es útil para depuración).
Ejemplo de solicitud (Reinicio simple)
Esta solicitud no tiene cuerpo.
PUT /rest/v1/control/reboot/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonEjemplo de solicitud (Informe de bloqueo)
PUT /rest/v1/control/reboot/?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: 56Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"crash_report": true
}
}Ejemplo de solicitud (Restablecimiento de fábrica)
PUT /rest/v1/control/reboot/?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: 57Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"factory_reset": true
}
}Ejemplo de solicitud (Deshabilitar Autorun)
PUT /rest/v1/control/reboot/?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: 56Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"autorun": "disable"
}
}Cuerpo de la respuesta
El servidor devolverá un mensaje de éxito o error. Una respuesta correcta casi siempre provocará un reinicio, lo que se indicará en la respuesta.
- resultado object: El objeto de respuesta
- éxito bool: Indica si la operación fue correcta o no
- reiniciar bool: Indica si el reproductor se está reiniciando o no
Ejemplos de respuesta
Informe de bloqueo
{
"data": {
"result": {
"success": true,
"message": "A reboot has been initiated (with crash report)"
}
},
"route": "/v1/control/reboot",
"method": "PUT"
}Restablecimiento de fábrica
{
"data": {
"result": {
"success": true,
"message": "A reboot has been initiated (with factory reset)"
}
},
"route": "/v1/control/reboot",
"method": "PUT"
}Deshabilitar Autorun
{
"data": {
"result": {
"success": true,
"message": "A reboot has been initiated"
}
},
"route": "/v1/control/reboot",
"method": "PUT"
}GET /control/dws-password/
Recupera información sobre la contraseña actual del DWS local (pero no la contraseña en sí), como si la contraseña está en blanco o no es válida
Ejemplo de solicitud
GET /rest/v1/control/dws-password/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- éxito bool: Un indicador que señala si la contraseña se leyó correctamente
- contraseña Password{ }: Un objeto Password que describe la contraseña del DWS. Los siguientes son valores posibles:
- isResultValid bool: Un indicador que señala si la contraseña del DWS es válida
- isBlank bool: Un indicador que señala si la contraseña del DWS está en blanco (es decir, no se requiere contraseña)
Ejemplo de respuesta
{
"route": "/v1/control/dws-password",
"method": "GET",
"data": {
"result": {
"success": true,
"password": {
"isResultValid": true,
"isBlank": true
}
}
}
}PUT /control/dws-password/
Establece una nueva contraseña para el DWS local (o elimina el requisito de contraseña en versiones anteriores de BOS).
Cuerpo de la solicitud
- contraseña string: La nueva contraseña del DWS local para el reproductor. A partir de BOS 9.0.128 y BOS 9.1.75, esta API aplica requisitos de contraseña fuerte, por lo que pasar una cadena vacía provocará un error. En versiones anteriores de BOS, la ausencia de este parámetro (o una cadena vacía) elimina el requisito de contraseña para el DWS.
- contraseña_anterior string: La contraseña anterior del DWS. Este parámetro debe incluirse. Este valor puede ser una cadena vacía para indicar que la contraseña anterior estaba en blanco.
Ejemplo de solicitud
PUT /rest/v1/control/dws-password/?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: 106Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"password": "newpassword",
"previous_password": "oldpassword"
}
}Cuerpo de la respuesta
- éxito bool: Un indicador que señala si la contraseña se estableció correctamente
- reiniciar bool: Un indicador que señala si el reproductor se reiniciará para establecer la contraseña
Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"reboot": false
}
},
"route": "/v1/control/dws-password",
"method": "PUT"
}
GET /control/local-dws/
Recupera el estado actual del DWS local
Ejemplo de solicitud
GET /rest/v1/control/local-dws/?destinationType=player&destinationName=27D33C000051 HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+jsonCuerpo de la respuesta
- éxito bool: Un indicador que señala si el DWS local está habilitado o deshabilitado
Ejemplo de respuesta
{
"route": "/v1/control/local-dws",
"method": "GET",
"data": {
"result": {
"success": true,
"value": true
}
}
}
PUT /control/local-dws/
Habilita o deshabilita el DWS local
Cuerpo de la solicitud
- habilitar bool: Un indicador que señala si el DWS local debe habilitarse o deshabilitarse
Ejemplo de solicitud
PUT /rest/v1/control/local-dws/?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: 50Este es el cuerpo de solicitud de ejemplo:
{
"data": {
"enable": true
}
}Cuerpo de la respuesta
- éxito bool: Un indicador que señala si el DWS local se habilitó o deshabilitó correctamente
- reiniciar bool: Un indicador que señala si el reproductor se reiniciará para habilitar/deshabilitar el DWS local
Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"reboot": true
}
},
"route": "/v1/control/local-dws",
"method": "PUT"
}
PUT /control/ssh-host-keys/reset/
Restablece las claves de host SSH regenerando nuevos pares de claves de host. Esto es útil por motivos de seguridad o cuando las claves de host se han visto comprometidas. El sistema determinará automáticamente si se requiere un reinicio, a menos que el parámetro reboot lo anule.
Ejemplo de solicitud
PUT /rest/v1/control/ssh-host-keys/reset/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 56Cuerpo de la solicitud
Este es el cuerpo de solicitud opcional de ejemplo:
{
"data": {
"reboot": "true"
}
}Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"value": true
}
}
}
PUT /control/dws-default-certs/reset/
Restablece los certificados predeterminados de DWS regenerando nuevos pares de certificados. Esto es útil por motivos de seguridad o cuando los certificados se han visto comprometidos. El sistema se reiniciará para activar los nuevos certificados, a menos que el parámetro reboot lo anule.
Ejemplo de solicitud
PUT /rest/v1/control/dws-default-certs/reset/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json
Content-Type: application/json
Content-Length: 56Cuerpo de la solicitud
Este es el cuerpo de solicitud opcional de ejemplo:
{
"data": {
"reboot": "true"
}
}Ejemplo de respuesta
{
"data": {
"result": {
"success": true,
"value": true
}
}
}