Puntos finales del dispositivo B-Deploy (v2)

14 min

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) docid\ io15aj04pawo ngktb2qq ejemplo de respuesta { "error" null, "result" { "total" 1, "matched" 1, "players" \[ { " id" "1a2b3c4d5e6f7a8b9c0d1e2f", "client" "baconnected", "networkname" "janedoenetwork", "username" "janedoe\@brightsign biz", "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) docid\ io15aj04pawo ngktb2qq ejemplo de respuesta { "error" null, "result" { " id" "1a2b3c4d5e6f7a8b9c0d1e2f", "client" "baconnected", "networkname" "janedoenetwork", "username" "janedoe\@brightsign biz", "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) docid\ io15aj04pawo ngktb2qq ejemplo de respuesta { "error" null, "result" { "total" 1, "matched" 1, "players" \[ { " id" "1a2b3c4d5e6f7a8b9c0d1e2f", "client" "baconnected", "networkname" "janedoenetwork", "username" "janedoe\@brightsign biz", "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) docid 16wcfdgso w2nr1 i3iqt 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) docid 16wcfdgso w2nr1 i3iqt 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 252 este es un ejemplo de cuerpo de solicitud con un setupid y setupname { "username" "janedoe\@brightsign biz", "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" "janedoe\@brightsign biz", "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 docid 16wcfdgso w2nr1 i3iqt 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 docid 16wcfdgso w2nr1 i3iqt 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 283 este es el cuerpo de solicitud de ejemplo para url { " id" "1a2b3c4d5e6f7a8b9c0d1e2f", "username" "janedoe\@brightsign biz", "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" "janedoe\@brightsign biz", "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