Puntos finales del dispositivo B-Deploy (v2)
Estos endpoints permiten a los usuarios aprovisionar automáticamente reproductores BrightSign a través de internet. Este endpoint gestiona todo lo relacionado con los reproductores individuales si agrega su número de serie al almacenamiento en la nube de BrightSign con un nombre de reproductor asociado, nombre del paquete de aprovisionamiento y la URL donde se aloja el paquete de aprovisionamiento. La URL es opcional; puede dejarse en blanco si se utiliza un paquete de configuración.
URL base para estos endpoints: https://provision.bsn.cloud/rest-device/v2/device/
GET
Recupera una colección de registros de aprovisionamiento que pertenecen a su red en B-Deploy
Parámetros de URL
- query[NetworkName] string required: El nombre de red de BSN.Cloud/BSN.com
- sort[serial] byte optional: Una marca que define si la lista devuelta debe ordenarse por el número de serie del reproductor
- page[pageNum] number optional: Un índice de una página en la lista paginada para recuperar
- page[pageSize] number optional: El número máximo de registros de aprovisionamiento en una página de la lista paginada
___________________________________________________
Ejemplo de solicitud
- query[NetworkName] está configurado en JaneDoeNetwork
- sort[serial] está configurado en 1
- page[pageNum] está configurado en 1
- page[pageSize] está configurado en 20
GET /rest-device/v2/device/?query%5BNetworkName%5D=JaneDoeNetwork&sort%5Bserial%5D=1&page%5BpageNum%5D=1&page%5BpageSize%5D=20 HTTP/1.1
Host: provision.bsn.cloud
Connection: Keep-Alive
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve una lista paginada de Entidad de registro de provisión (v2)
Ejemplo de respuesta
{
"error": null,
"result": {
"total": 1,
"matched": 1,
"players": [
{
"_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
"client": "baconnected",
"NetworkName": "JaneDoeNetwork",
"username": "[email protected]",
"serial": "123456789012",
"name": "My Player",
"model": "XC4055",
"desc": "Brand New Player",
"setupName": "My Setup Package",
"createdAt": "2024-08-25T13:38:00.042Z",
"updatedAt": "2024-08-25T13:38:00.042Z",
"__v": 0
}
],
"priv": "user"
}
}Respuesta de error
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método.
5XX: Cualquier código 500 es un error interno del servidor
GET /?_id={string}
Recupera un registro de aprovisionamiento de B-Deploy que tiene el ID especificado.
Parámetro de cadena de consulta
- _id string required: El identificador único del registro de aprovisionamiento que se va a recuperar. Si este parámetro no se incluye en la URL, la solicitud GET devolverá todos los registros de aprovisionamiento asociados con la cuenta
___________________________________________________
Ejemplo de solicitud
- _id está establecido en 1a2b3c4d5e6f7a8b9c0d1e2f
GET /rest-device/v2/device/?_id=1a2b3c4d5e6f7a8b9c0d1e2f HTTP/1.1
Host: provision.bsn.cloud
Connection: Keep-Alive
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la entidad especificada Entidad de registro de provisión (v2)
Ejemplo de respuesta
{
"error": null,
"result": {
"_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
"client": "baconnected",
"NetworkName": "JaneDoeNetwork",
"username": "[email protected]",
"serial": "ABCD00000001",
"name": "ProvisionTest",
"model": "XC4055",
"desc": "Brand New Player",
"setupName": "My Setup Package",
"createdAt": "2024-08-25T13:38:00.042Z",
"updatedAt": "2024-08-25T13:38:00.042Z",
"__v": 0
}
}Respuesta de error
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método.
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
5XX: Cualquier código 500 es un error interno del servidor
GET /?serial={string}
Recupera un registro de aprovisionamiento de B-Deploy creado para un reproductor que tiene el número de serie especificado.
Parámetro de cadena de consulta
- serie string required: El número de serie de un reproductor que está especificado por un registro de aprovisionamiento. Si este parámetro no se incluye en la URL, la solicitud GET devolverá todos los registros de aprovisionamiento asociados con la cuenta
___________________________________________________
Ejemplo de solicitud
- serie está establecido en ABCD00000001
GET /rest-device/v2/device/?serial=ABCD00000001 HTTP/1.1
Host: provision.bsn.cloud
Connection: Keep-Alive
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la entidad especificada Entidad de registro de provisión (v2)
Ejemplo de respuesta
{
"error": null,
"result": {
"total": 1,
"matched": 1,
"players": [
{
"_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
"client": "baconnected",
"NetworkName": "JaneDoeNetwork",
"username": "[email protected]",
"serial": "ABCD00000001",
"name": "ProvisionTest",
"model": "XC4055",
"desc": "Brand New Player",
"setupName": "My Setup Package",
"createdAt": "2024-08-25T13:38:00.042Z",
"updatedAt": "2024-08-25T13:38:00.042Z",
"__v": 0
}
],
"priv": "user"
}
}Respuesta de error
400: La solicitud tiene un formato incorrecto y, por lo tanto, es inválida
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método.
5XX: Cualquier código 500 es un error interno del servidor
POST
Crea un registro de aprovisionamiento para un reproductor específico y hace referencia a un paquete de configuración almacenado en B-Deploy o proporcionado por un servicio externo.
Cuerpo de la solicitud
- nombre de usuario string required: El inicio de sesión de la persona que posee el registro. Tenga en cuenta que la persona puede o no estar registrada en BSN.Cloud.
- serie string required: El número de serie del reproductor representado por el registro de aprovisionamiento
- nombre string optional: El nombre que obtendrá el reproductor de destino como resultado del aprovisionamiento. Cuando se especifica, reemplaza los valores especificados en el paquete de configuración referenciado.
- NetworkName string required: El nombre de la red en la que se debe aprovisionar el reproductor especificado
- modelo string optional: El modelo del reproductor que tiene el número de serie especificado
- descripción string optional: La descripción que obtendrá el reproductor de destino como resultado del aprovisionamiento. Cuando se especifica, reemplaza los valores especificados en el paquete de configuración referenciado.
- setupId string optional: El identificador único del paquete de configuración almacenado en B-Deploy y administrado mediante la API de PSS documentada en B-Deploy Configurar puntos finales (v2)
- setupName string optional: El nombre descriptivo de un paquete de configuración almacenado en B-Deploy y administrado mediante la API de PSS documentada en B-Deploy Configurar puntos finales (v2)
- url string optional: La URL desde la cual el reproductor descargará su presentación como parte del paso final de aprovisionamiento
- userdata string optional: Le permite proporcionar atributos adicionales a un paquete de configuración personalizado
Ejemplo de solicitud
POST /rest-device/v2/device HTTP/1.1
Host: provision.bsn.cloud
Content-Type: application/json
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 252Este es un ejemplo de cuerpo de solicitud con un setupId y setupName:
{
"username": "[email protected]",
"serial": "ABCD00000001",
"name": "ProvisionTest",
"NetworkName": "Test",
"model": "XC4055",
"desc": "Jane's player",
"setupId": "f2e1d0c9b8a7f6e5d4c3b2a1",
"setupName": "My Setup Package",
"userdata": ""
}Este es un ejemplo de cuerpo de solicitud con una url:
{
"username": "[email protected]",
"serial": "ABCD00000001",
"name": null,
"NetworkName": "Test",
"model": "XC4055",
"desc": "Jane's player",
"userdata": "key=value",
"url": "https://provisiondemo.brightsignnetwork.com/autorun.zip"
}___________________________________________________
Respuesta satisfactoria
201: Devuelve el identificador único de un registro de aprovisionamiento creado en B-Deploy y agregado a su red
Respuesta de error
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
415: El servidor no puede aceptar la representación de datos que usted envió (según se especifica en el encabezado)
5XX: Cualquier código 500 es un error interno del servidor
PUT /?_id={string}
Modifica un registro de aprovisionamiento de un reproductor especificado en B-Deploy
Cuerpo de la solicitud
- _id string requerido: El identificador único (un número hexadecimal de 24 dígitos) del objeto del dispositivo
- nombre de usuario string requerido: El inicio de sesión de la persona propietaria del registro. Tenga en cuenta que la persona puede o no estar registrada en BSN.Cloud.
- serie string requerido: El número de serie del reproductor representado por el registro de aprovisionamiento
- nombre string opcional: El nombre que obtendrá el reproductor de destino como resultado del aprovisionamiento. Cuando se especifica, reemplaza los valores especificados en el paquete de configuración referenciado.
- NetworkName string requerido: El nombre de la red a la que se debe aprovisionar el reproductor especificado
- modelo string opcional: El modelo del reproductor que tiene el serie
- descripción string opcional: La descripción que obtendrá el reproductor de destino como resultado del aprovisionamiento. Cuando se especifica, reemplaza los valores especificados en el paquete de configuración referenciado.
- setupId string optional: El identificador único del paquete de configuración almacenado en B-Deploy y administrado mediante la PSS API documentada en esta página.
- setupName string optional: El nombre descriptivo de un paquete de configuración almacenado en B-Deploy y administrado mediante la PSS API documentada en esta página.
- url string optional: Hace referencia al paquete de configuración o controlador proporcionado por servicios externos, como aplicaciones de socios.
- userdata string optional: Una propiedad opcional que le permite proporcionar atributos adicionales a un paquete de configuración personalizado
___________________________________________________
Ejemplo de solicitud Ejemplo
Este método requiere un valor de propiedad url con un formato de valor URL absoluto o un par de valores de propiedad setupId y setupName.
PUT /rest-device/v2/device/ HTTP/1.1
Host: provision.bsn.cloud
Content-Type: application/json
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 283Este es el cuerpo de solicitud de ejemplo para url:
{
"_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
"username": "[email protected]",
"serial": "ABCD00000001",
"name": "ProvisionTest",
"NetworkName": "Test",
"model": "XC4055",
"desc": "Jane's player",
"url": "https://www.janeplayers.com/setups/autorun.zip",
"userdata": "key=value"
}Este es el cuerpo de solicitud de ejemplo para setupId y setupName:
{
"_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
"username": "[email protected]",
"serial": "ABCD00000001",
"name": "ProvisionTest",
"NetworkName": "Test",
"model": "XC4055",
"desc": "Jane's player",
"setupId": "f2e1d0c9b8a7f6e5d4c3b2a1",
"setupName": "My Setup Package",
"userdata": ""
}___________________________________________________
Respuesta exitosa
200: Las propiedades del registro de aprovisionamiento existente se han actualizado.
Respuesta de error
400: Tanto la solicitud como el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
415: El servidor no puede aceptar la representación de datos que usted envió (según se especifica en el encabezado)
5XX: Cualquier código 500 es un error interno del servidor
DELETE /?_id={string}
Elimina un registro de aprovisionamiento que tenga el ID especificado en B-Deploy
Parámetro de Query String
- _id string required: El identificador del registro de la base de datos del reproductor
___________________________________________________
Ejemplo de solicitud Ejemplo
- _id se establece en 1a2b3c4d5e6f7a8b9c0d1e2f
DELETE /rest-device/v2/device/?_id=1a2b3c4d5e6f7a8b9c0d1e2f HTTP/1.1
Host: provision.bsn.cloud
Content-Type: application/json
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Respuesta satisfactoria
200: El registro de aprovisionamiento especificado se ha eliminado
Respuesta de error
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: No existe un registro de aprovisionamiento con el ID especificado
5XX: Cualquier código 500 es un error interno del servidor
DELETE /?serial={string}
Elimina un registro de aprovisionamiento relacionado con un reproductor que tiene el número de serie especificado en B-Deploy
Parámetro de cadena de consulta
- serie string required: El número de serie del reproductor
___________________________________________________
Ejemplo de solicitud Ejemplo
- serie se establece en ABCD00000001
DELETE /rest-device/v2/device/?serial=ABCD00000001 HTTP/1.1
Host: provision.bsn.cloud
Content-Type: application/json
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Respuesta satisfactoria
200: El registro de aprovisionamiento especificado se ha eliminado
Respuesta de error
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: No existe un registro de aprovisionamiento con el número de serie especificado
5XX: Cualquier código 500 es un error interno del servidor
DELETE /ids/{array}
Elimina una colección de registros de aprovisionamiento que tienen los identificadores especificados en B-Deploy
Segmento
matriz string[]
Una matriz de identificadores de registros de aprovisionamiento
___________________________________________________
Ejemplo de solicitud Ejemplo
- matriz se establece en ["1a2b3c4d5e6f7a8b9c0d1e2f"]
DELETE /rest-device/v2/device/ids/["1a2b3c4d5e6f7a8b9c0d1e2f"] HTTP/1.1
Host: provision.bsn.cloud
Connection: Keep-Alive
Authorization: {{Bearer Token}}
Accept: application/json
Accept-Encoding: gzip,deflate___________________________________________________
Respuesta correcta
200: La solicitud se ejecuta correctamente y la indicación de qué registros se han eliminado está en la carga útil de la respuesta.
Ejemplo de respuesta
{
"error": null,
"result": {
"deletedCount": 1,
"deletedIds": ["1a2b3c4d5e6f7a8b9c0d1e2f"],
"failedIds": [],
"message": "All players were deleted successfully"
}
}Respuesta de error
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se ha especificado
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
5XX: Cualquier código 500 es un error interno del servidor