---
title: API DWS remotas
slug: develop/es/api-dws-remotas
docTags: 
createdAt: 2025-03-11T07:03:32.132Z
---

Remote DWS le permite ver y modificar configuraciones en un reproductor BrightSign a través de Internet. La API de Remote DWS es un framework REST que permite que una aplicación cliente se integre con la funcionalidad de Remote DWS.

La aplicación cliente realiza llamadas REST al servidor BrightSign WebSockets, que a su vez envía mensajes WebSockets a los reproductores BrightSign. Dependiendo de la operación, el reproductor BrightSign puede devolver información al servidor BrightSign WebSockets, que se retransmitirá en la respuesta REST del servidor a la aplicación cliente.

## URL REST

La URL base de la API de DWS remoto es [https://ws.bsn.cloud/rest/v1/](https://ws.bsn.cloud/rest/v1/).&#x20;

Tenga en cuenta que la sección REST distingue entre mayúsculas y minúsculas y el servidor puede devolver el código 404 si las mayúsculas y minúsculas no coinciden exactamente.

## Autenticación

Todas las llamadas a la API de Remote DWS requieren un token de acceso OAuth2 válido que puede emitirse ya sea para un usuario o para la aplicación cliente. El reproductor de destino debe pertenecer a la misma red para la cual se otorgó el token.&#x20;

Siga la guía [Autenticación](docId\:u_-NJ27EzaIs8KnCUX2mf) para registrar sus aplicaciones y obtener tokens de acceso que concedan acceso a la API de Remote DWS.

### Encabezados de solicitud

Debe incluir los siguientes encabezados de solicitud en su solicitud. El encabezado Content-Type solo es necesario cuando se envía contenido en llamadas API POST o PUT.

```text
headers: {
	'Accept': 'application/json, application/vnd.bsn.error+json',
	'Authorization': 'Bearer {{UserAccessToken}}',
	'Content-Type': 'application/json',
}
```

## Formato del mensaje de solicitud

Las solicitudes HTTP a los recursos de Remote DWS deben tener formato JSON y contener los siguientes parámetros URL:

- `destinationType`  <font color="#704ae0">string</font>: El tipo de dispositivo. El único valor aceptado actualmente es "player".
- `destinationName`  <font color="#704ae0">string</font>: El número de serie del dispositivo

Las solicitudes que requieren un cuerpo JSON deben tener un objeto data externo. Por ejemplo, si una ruta espera `habilitado` <font color="#704ae0">bool</font> entonces el cuerpo JSON completo se vería así:

```json
{
  "data": {
    "enabled": false
  }
}
```

Algunas solicitudes también requieren propiedades específicas del recurso en la URL o el cuerpo de la solicitud, como se detalla en las secciones **Parámetros URL** y **Cuerpo de la solicitud** a continuación.

## Formato del mensaje de respuesta

El servidor responderá a una solicitud REST con un mensaje de éxito o error, que también puede contener propiedades específicas del recurso, como se detalla en las secciones **Cuerpo de la respuesta** a continuación.

Los objetos JSON devueltos tendrán un objeto externo que contiene los métodos siguientes, donde data es un objeto de error o de resultado que contiene los valores devueltos:

- `ruta` <font color="#704ae0">string</font>: La ruta a la que se envió la solicitud
- `método` <font color="#704ae0">string</font>: El método de solicitud
- `datos` <font color="#704ae0">object</font>: Los datos devueltos

Por ejemplo:

```json
{
  "route": "/v1/info",
  "method": "GET",
  "data": {
    "result": {
      "model": "LS424"
      ...
    }
  }
}
```

