Configuración de puntos de conexión de B-Deploy (v3)

8 min

Estos endpoints permiten a los usuarios aprovisionar automáticamente reproductores BrightSign a través de internet. Este endpoint maneja todo lo relacionado con reproductores individuales. Agregue su número de serie al almacenamiento en la nube de BrightSign con un nombre de reproductor asociado, un nombre de paquete de aprovisionamiento y la URL donde está alojado el paquete de aprovisionamiento. La URL es opcional; puede dejarse en blanco si se utiliza un paquete de Setup.

La versión 3.0 de estas APIs contiene soporte adicional para múltiples interfaces de red mediante el objeto RedNetwork.

URL base para estos endpoints: https://provision.bsn.cloud/rest-setup/v3/setup/

_____________________________________________________________

GET /

Devuelve una lista de registros de configuración en el formato exacto en que están almacenados en la base de datos B-deploy. Los principales valores de configuración se almacenan en cada objeto del arreglo en el parámetro “setupJson”.

Si desea obtener información sobre una configuración específica de B-Deploy, consulte GET /:_id/

Parámetro de cadena de consulta

NombreDeRed string obligatorio: El nombre definido por el usuario de la red BSN.Cloud

nombre de usuario string opcional: El nombre del usuario que creó el paquete de Setup

packageName string opcional: El nombre definido por el usuario del paquete de Setup.

Ejemplo de solicitud

nombre de usuario está establecido en [email protected]

NombreDeRed está establecido en JaneDoeNetwork

packageName está establecido en Mi paquete de configuración

GET /rest-setup/v3/setup/?username=JaneDoe%40brightsign.biz&NetworkName=JaneDoeNetwork&packageName=My%20Setup%20Package HTTP/1.1
Host: provision.bsn.cloud
Authorization: {{Bearer Token}}
Accept: application/json

________________________________________________________

Cuerpo de la respuesta exitosa

200: Devuelve una lista de Entidad de información del paquete de configuración (v3)

Ejemplo de respuesta exitosa

{
  "error": null,
  "result": [
    {
      "_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
      "username": "[email protected]",
      "client": "bacon",
      "packageName": "My Setup Package",
      "setupType": "bsn",
      "networkName": "JaneDoeNetwork",
      "deviceName": "My Player",
      "deviceDescription": "",
      "bsnGroupName": "Default",
      "setupJson": "{\"version\":\"3.0.0\",\"_id\":\"1a2b3c4d5e6f7a8b9c0d1e2f\",\"bDeploy\":{\"username\":\"[email protected]\",\"networkName\":\"JaneDoeNetwork\",\"client\":\"bacon\",\"packageName\":\"NewTimezone\"},\"firmwareUpdatesByFamily\":{\"Impala\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"impala-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"impala-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"impala-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"impala-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/impala-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/impala-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/impala-8.0.146-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.0.146\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524434,\"productionReleaseSHA1\":\"4dcf3e2dae41d05e49f3bc6a8ed49925d1cbb75a\",\"betaReleaseSHA1\":\"4dcf3e2dae41d05e49f3bc6a8ed49925d1cbb75a\",\"compatibleReleaseSHA1\":\"789cf557fbb0a5f70ecc103e5d071186b57eb38f\",\"productionReleaseFileLength\":144788480,\"betaReleaseFileLength\":144788480,\"compatibleReleaseFileLength\":137811964,\"existingFWContentID\":\"\"},\"Pantera\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"pantera-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"pantera-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"pantera-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"pantera-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pantera-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pantera-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pantera-8.0.146-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.0.146\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524434,\"productionReleaseSHA1\":\"ee9ef5265c5ff85c77e4a87f264f8cf1112225ed\",\"betaReleaseSHA1\":\"ee9ef5265c5ff85c77e4a87f264f8cf1112225ed\",\"compatibleReleaseSHA1\":\"58196ad8707b6e62185f1aba6d124ed1adfa7f67\",\"productionReleaseFileLength\":144337538,\"betaReleaseFileLength\":144337538,\"compatibleReleaseFileLength\":137509058,\"existingFWContentID\":\"\"},\"Tiger\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"tiger-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"tiger-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"tiger-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"tiger-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/tiger-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/tiger-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/tiger-8.0.146-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.0.146\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524434,\"productionReleaseSHA1\":\"45df4348e6ce1039fa54f8a3fa3bf0e6e95dacca\",\"betaReleaseSHA1\":\"45df4348e6ce1039fa54f8a3fa3bf0e6e95dacca\",\"compatibleReleaseSHA1\":\"f02173d13f800d8d264d761226f783baa27b44b2\",\"productionReleaseFileLength\":156481838,\"betaReleaseFileLength\":156481838,\"compatibleReleaseFileLength\":147734484,\"existingFWContentID\":\"\"},\"Pagani\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"pagani-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"pagani-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"pagani-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"pagani-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pagani-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pagani-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/pagani-8.0.146-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.0.146\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524434,\"productionReleaseSHA1\":\"8dd2ede70c9095392fb30e031b9376922af98528\",\"betaReleaseSHA1\":\"8dd2ede70c9095392fb30e031b9376922af98528\",\"compatibleReleaseSHA1\":\"9af7416c055f9fe45d3b492ad00a7cb8b0e5f7ff\",\"productionReleaseFileLength\":190350854,\"betaReleaseFileLength\":190350854,\"compatibleReleaseFileLength\":167649562,\"existingFWContentID\":\"\"},\"Malibu\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"malibu-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"malibu-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"malibu-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"malibu-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/malibu-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/malibu-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/malibu-8.0.146-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.0.146\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524434,\"productionReleaseSHA1\":\"5358940fe1aa6742aa8a9e0f82c1920991476867\",\"betaReleaseSHA1\":\"5358940fe1aa6742aa8a9e0f82c1920991476867\",\"compatibleReleaseSHA1\":\"b897e81655879cc0cf7a73fad79aa615cb17da31\",\"productionReleaseFileLength\":191643784,\"betaReleaseFileLength\":191643784,\"compatibleReleaseFileLength\":178140054,\"existingFWContentID\":\"\"},\"Sebring\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"sebring-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"sebring-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"sebring-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"sebring-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/sebring-8.5.47-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/sebring-8.5.47-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/sebring-8.2.17.3-update.bsfw\",\"productionVersion\":\"8.5.47\",\"betaVersion\":\"8.5.47\",\"compatibleVersion\":\"8.2.17.3\",\"productionVersionNumber\":525615,\"betaVersionNumber\":525615,\"compatibleVersionNumber\":524817,\"productionReleaseSHA1\":\"8c14e14c01251e6dae32bba286b3bf79ec34cffa\",\"betaReleaseSHA1\":\"8c14e14c01251e6dae32bba286b3bf79ec34cffa\",\"compatibleReleaseSHA1\":\"399b5dd4203a8283f8e357a41e0168c33eb2418a\",\"productionReleaseFileLength\":81108806,\"betaReleaseFileLength\":81108806,\"compatibleReleaseFileLength\":74604516,\"existingFWContentID\":\"\"},\"Raptor\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"raptor-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"raptor-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"raptor-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"raptor-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.145.1-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.145.1-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.22.3-update.bsfw\",\"productionVersion\":\"9.0.145.1\",\"betaVersion\":\"9.0.145.1\",\"compatibleVersion\":\"9.0.22.3\",\"productionVersionNumber\":589969,\"betaVersionNumber\":589969,\"compatibleVersionNumber\":589846,\"productionReleaseSHA1\":\"06ffdc99949dddf1645ad738ce4508597f0e8db0\",\"betaReleaseSHA1\":\"06ffdc99949dddf1645ad738ce4508597f0e8db0\",\"compatibleReleaseSHA1\":\"245ef90811a7bcd2e1ca862b451c4d8abfaa5526\",\"productionReleaseFileLength\":443631114,\"betaReleaseFileLength\":443631114,\"compatibleReleaseFileLength\":343723720,\"existingFWContentID\":\"\"},\"Cobra\":{\"firmwareUpdateSource\":null,\"firmwareUpdateSourceFilePath\":\"\",\"firmwareUpdateSourceUrl\":\"\",\"firmwareUpdateStandardTargetFileName\":\"cobra-update.bsfw\",\"firmwareUpdateDifferentTargetFileName\":\"cobra-update_different.bsfw\",\"firmwareUpdateNewerTargetFileName\":\"cobra-update_newer.bsfw\",\"firmwareUpdateSaveTargetFileName\":\"cobra-update_save.bsfw\",\"firmwareUpdateVersion\":\"\",\"productionReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/cobra-9.0.145.1-update.bsfw\",\"betaReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/cobra-9.0.145.1-update.bsfw\",\"compatibleReleaseURL\":\"https://bsncloud.s3.amazonaws.com/public/cobra-9.0.75-update.bsfw\",\"productionVersion\":\"9.0.145.1\",\"betaVersion\":\"9.0.145.1\",\"compatibleVersion\":\"9.0.75\",\"productionVersionNumber\":589969,\"betaVersionNumber\":589969,\"compatibleVersionNumber\":589899,\"productionReleaseSHA1\":\"7d53871f30852a7851b5fa4a88f4640b4d18aa40\",\"betaReleaseSHA1\":\"7d53871f30852a7851b5fa4a88f4640b4d18aa40\",\"compatibleReleaseSHA1\":\"a213680fa5d8fb9437bee43888c37b9fd932f62d\",\"productionReleaseFileLength\":361576318,\"betaReleaseFileLength\":361576318,\"compatibleReleaseFileLength\":259763696,\"existingFWContentID\":\"\"}},\"firmwareUpdateType\":\"standard\",\"setupType\":\"bsn\",\"bsnDeviceRegistrationTokenEntity\":{\"token\":\"QBzIU4fdYEvWZ8R7EdwK3ISDRH72sDUi6K7FEl2cmNA5pZBxBNDn12qgWF78zGGMMOBoDTp898SsdTCSZy469ZKxwBoXxtarHTl71F3Y6ImfGXkyHnsxIwNCZYfctXoD\",\"scope\":\"cert\",\"validFrom\":\"2024-05-08T18:42:18.000Z\",\"validTo\":\"2026-05-08T18:42:18.000Z\"},\"enableSerialDebugging\":false,\"enableSystemLogDebugging\":false,\"remoteDwsEnabled\":true,\"dwsEnabled\":true,\"dwsPassword\":\"\",\"dwsPasswordPreviousSavedTimeStamp\":1714573782270,\"lwsEnabled\":true,\"lwsConfig\":\"status\",\"lwsUserName\":\"\",\"lwsPassword\":\"\",\"lwsEnableUpdateNotifications\":true,\"bsnCloudEnabled\":true,\"deviceName\":\"Series 5\",\"deviceDescription\":\"\",\"unitNamingMethod\":\"appendUnitIDToUnitName\",\"timeZone\":\"EST\",\"bsnGroupName\":\"Default\",\"timeBetweenNetConnects\":300,\"sfnWebFolderUrl\":\"\",\"sfnUserName\":\"\",\"sfnPassword\":\"\",\"sfnEnableBasicAuthentication\":false,\"playbackLoggingEnabled\":false,\"eventLoggingEnabled\":false,\"diagnosticLoggingEnabled\":false,\"stateLoggingEnabled\":false,\"variableLoggingEnabled\":false,\"uploadLogFilesAtBoot\":false,\"uploadLogFilesAtSpecificTime\":false,\"uploadLogFilesTime\":0,\"logHandlerUrl\":\"\",\"enableRemoteSnapshot\":false,\"remoteSnapshotInterval\":15,\"remoteSnapshotMaxImages\":5,\"remoteSnapshotJpegQualityLevel\":50,\"remoteSnapshotScreenOrientation\":\"Landscape\",\"remoteSnapshotHandlerUrl\":\"\",\"idleScreenColor\":{\"r\":112,\"g\":40,\"b\":150,\"a\":1},\"networkDiagnosticsEnabled\":false,\"testEthernetEnabled\":false,\"testWirelessEnabled\":false,\"testInternetEnabled\":false,\"useCustomSplashScreen\":false,\"BrightWallName\":\"\",\"BrightWallScreenNumber\":\"\",\"contentDownloadsRestricted\":false,\"contentDownloadRangeStart\":0,\"contentDownloadRangeEnd\":0,\"usbUpdatePassword\":\"\",\"inheritNetworkProperties\":true,\"internalCaArtifacts\":[],\"network\":{\"timeServers\":[\"http://time.brightsignnetwork.com\"],\"hostname\":null,\"dns\":null,\"proxyServer\":null,\"proxyBypass\":null,\"interfaces\":[{\"id\":\"wired_eth0\",\"name\":\"eth0\",\"type\":\"Ethernet\",\"proto\":\"DHCPv4\",\"ip\":[],\"gateway\":null,\"dns\":[],\"rateLimitDuringInitialDownloads\":0,\"rateLimitInsideContentDownloadWindow\":0,\"rateLimitOutsideContentDownloadWindow\":null,\"contentDownloadEnabled\":true,\"textFeedsDownloadEnabled\":true,\"mediaFeedsDownloadEnabled\":true,\"healthReportingEnabled\":true,\"logsUploadEnabled\":true,\"wpaSettings\":{\"enableWPAEnterpriseAuthentication\":false,\"wpaEnterpriseVariant\":\"WPAEnterpriseEapTls\",\"eapCertificateType\":\"WPAEapTlsPKCS\",\"eapCertificateFile\":null,\"eapCertificatePassphrase\":\"\",\"eapPemOrDerKeyFile\":null,\"peapUsername\":\"\",\"peapPassphrase\":\"\",\"caCertificateFile\":null}}]}}",
      "version": "3.0.0",
      "createdAt": "2025-03-28T22:22:36.900Z",
      "updatedAt": "2025-05-08T18:42:18.692Z",
      "__v": 0
    }
  ]
}

Respuesta de error

400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida (por ejemplo, no se especifica NombreDeRed)

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. El token de acceso utilizado para llamar a esta API /v3/setup debe pertenecer a la misma red.

5XX: Cualquier código 500 es un error interno del servidor

GET /:_id/

Recupera un paquete Setup que tiene el ID especificado del servidor B-Deploy.

Parámetro de ruta

_id string obligatorio: El identificador principal del paquete Setup que desea recuperar. Este "id" se devuelve en la respuesta a /rest-setup/v3/setup/POST.

Ejemplo de solicitud

GET /rest-setup/v3/setup/1a2b3c4d5e6f7a8b9c0d1e2f/ HTTP/1.1
Host: provision.bsn.cloud
Authorization: {{Bearer Token}}
Accept: application/json

________________________________________________________

Cuerpo de la respuesta correcta

200: Devuelve una matriz vacía de errores de configuración del dispositivo y la Entidad de configuración del dispositivo (v3).

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. El token de acceso utilizado para llamar a esta API /v3/setup debe pertenecer a la misma red.

5XX: Cualquier código 500 es un error interno del servidor

POST /

Crea un paquete Setup en el servidor B-Deploy

Cuerpo de la solicitud

La Entidad de configuración del dispositivo (v3)Device Setup Entity (v3)

Ejemplo de solicitud

POST /rest-setup/v3/setup HTTP/1.1
Host: provision.bsn.cloud
Authorization: {{Bearer Token}}
Content-Type: application/json
Content-Length: 10427
Accept: application/json

Este es el cuerpo de solicitud de ejemplo:

{
  "version": "3.0.0",
  "bDeploy": {
    "username": "[email protected]",
    "networkName": "JaneDoeNetwork",
    "packageName": "FullSetup2"
    },
  "setupType": "bsn",
  "bsnDeviceRegistrationTokenEntity": {
    "token": {{token}},
    "scope": "certs",
    "validFrom": "2024-09-28T19:47:09.577Z",
    "validTo": "2026-09-28T19:47:09.577Z"
    },
  "firmwareUpdateType": "standard",
  "enableSerialDebugging": true,
  "enableSystemLogDebugging": true,
  "dwsEnabled": true,
  "dwsPassword": "",
  "lwsEnabled": true,
  "lwsConfig": "status",
  "lwsUserName": "",
  "lwsPassword": "",
  "lwsEnableUpdateNotifications": true,
  "deviceName": "",
  "deviceDescription": "",
  "unitNamingMethod": "appendUnitIDToUnitName",
  "timeZone": "PST",
  "bsnGroupName": "Default",
  "timeBetweenNetConnects": 300,
  "timeBetweenHeartbeats": 900,
  "sfnWebFolderUrl": "",
  "sfnUserName": "",
  "sfnPassword": "",
  "sfnEnableBasicAuthentication": false,
  "playbackLoggingEnabled": false,
  "eventLoggingEnabled": false,
  "diagnosticLoggingEnabled": false,
  "stateLoggingEnabled": false,
  "variableLoggingEnabled": false,
  "uploadLogFilesAtBoot": false,
  "uploadLogFilesAtSpecificTime": false,
  "uploadLogFilesTime": 0,
  "logHandlerUrl": "",
  "enableRemoteSnapshot": false,
  "remoteSnapshotInterval": 69,
  "remoteSnapshotMaxImages": 69,
  "remoteSnapshotJpegQualityLevel": 100,
  "remoteSnapshotScreenOrientation": "Landscape",
  "remoteSnapshotHandlerUrl": "",
  "useWireless": false,
  "ssid": "",
  "passphrase": "",
  "timeServer": "http://time.brightsignnetwork.com",
  "idleScreenColor": {
    "r": 0,
    "g": 0,
    "b": 0,
    "a": 1
  },
  "contentDataTypeEnabledWired": true,
  "textFeedsDataTypeEnabledWired": true,
  "healthDataTypeEnabledWired": true,
  "mediaFeedsDataTypeEnabledWired": true,
  "logUploadsXfersEnabledWired": true,
  "contentDataTypeEnabledWireless": true,
  "textFeedsDataTypeEnabledWireless": true,
  "healthDataTypeEnabledWireless": true,
  "mediaFeedsDataTypeEnabledWireless": true,
  "logUploadsXfersEnabledWireless": true,
  "rateLimitModeOutsideWindow": "default",
  "rateLimitRateOutsideWindow": 0,
  "rateLimitModeInWindow": "unlimited",
  "rateLimitRateInWindow": 0,
  "rateLimitModeInitialDownloads": "unlimited",
  "rateLimitRateInitialDownloads": 0,
  "networkConnectionPriority": "wired",
  "networkDiagnosticsEnabled": false,
  "testEthernetEnabled": false,
  "testWirelessEnabled": false,
  "testInternetEnabled": false,
  "useCustomSplashScreen": false,
  "BrightWallName": "",
  "BrightWallScreenNumber": "",
  "specifyHostname": false,
  "hostname": "",
  "useProxy": false,
  "proxyAddress": "",
  "proxyPort": 0,
  "networkHosts": [],
  "contentDownloadsRestricted": false,
  "contentDownloadRangeStart": 0,
  "contentDownloadRangeEnd": 0,
  "heartbeatsRestricted": false,
  "heartbeatsRangeStart": 0,
  "heartbeatsRangeEnd": 0,
  "useDHCP": true,
  "staticIPAddress": "",
  "subnetMask": "",
  "gateway": "",
  "dns1": "",
  "dns2": "",
  "dns3": "",
  "useDHCP_2": true,
  "staticIPAddress_2": "",
  "subnetMask_2": "",
  "gateway_2": "",
  "dns1_2": "",
  "dns2_2": "",
  "dns3_2": "",
  "rateLimitModeOutsideWindow_2": "default",
  "rateLimitRateOutsideWindow_2": 0,
  "rateLimitModeInWindow_2": "unlimited",
  "rateLimitRateInWindow_2": 0,
  "rateLimitModeInitialDownloads_2": "unlimited",
  "rateLimitRateInitialDownloads_2": 0,
  "usbUpdatePassword": "",
  "remoteDwsEnabled": true
}

________________________________________________________

Cuerpo de la respuesta exitosa

201: El ID del paquete Setup recién creado

Respuesta

{
  "error": null,
  "result": "1a2b3c4d5e6f7a8b9c0d1e2f"
}

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 válido, no proporciona acceso a este método

415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado)

5XX: Cualquier código 500 es un error interno del servidor

PUT /

Modifica un paquete Setup existente en el servidor B-Deploy

Cuerpo de la solicitud

DeviceSetup objeto: Una Entidad de configuración del dispositivo (v3)Device Setup Entity (v3)

Solicitud de ejemplo

PUT /rest-setup/v3/setup HTTP/1.1
Host: provision.bsn.cloud
Authorization: {{Bearer Token}}
Content-Type: application/json
Content-Length: 5058
Accept: application/json

Este es el cuerpo de la solicitud de ejemplo:

{
  "version": "3.0.0",
  "bDeploy": {
    "username": "[email protected]",
    "networkName": "JaneDoeNetwork",
    "packageName": "FullSetup2"
    },
  "setupType": "bsn",
  "bsnDeviceRegistrationTokenEntity": {
    "token": {{token}},
    "scope": "certs",
    "validFrom": "2024-09-28T19:47:09.577Z",
    "validTo": "2026-09-28T19:47:09.577Z"
    },
  "firmwareUpdateType": "standard",
  "enableSerialDebugging": true,
  "enableSystemLogDebugging": true,
  "dwsEnabled": true,
  "dwsPassword": "",
  "lwsEnabled": true,
  "lwsConfig": "status",
  "lwsUserName": "",
  "lwsPassword": "",
  "lwsEnableUpdateNotifications": true,
  "deviceName": "",
  "deviceDescription": "",
  "unitNamingMethod": "appendUnitIDToUnitName",
  "timeZone": "PST",
  "bsnGroupName": "Default",
  "timeBetweenNetConnects": 300,
  "timeBetweenHeartbeats": 900,
  "sfnWebFolderUrl": "",
  "sfnUserName": "",
  "sfnPassword": "",
  "sfnEnableBasicAuthentication": false,
  "playbackLoggingEnabled": false,
  "eventLoggingEnabled": false,
  "diagnosticLoggingEnabled": false,
  "stateLoggingEnabled": false,
  "variableLoggingEnabled": false,
  "uploadLogFilesAtBoot": false,
  "uploadLogFilesAtSpecificTime": false,
  "uploadLogFilesTime": 0,
  "logHandlerUrl": "",
  "enableRemoteSnapshot": false,
  "remoteSnapshotInterval": 69,
  "remoteSnapshotMaxImages": 69,
  "remoteSnapshotJpegQualityLevel": 100,
  "remoteSnapshotScreenOrientation": "Landscape",
  "remoteSnapshotHandlerUrl": "",
  "useWireless": false,
  "ssid": "",
  "passphrase": "",
  "timeServer": "http://time.brightsignnetwork.com",
  "idleScreenColor": {
    "r": 0,
    "g": 0,
    "b": 0,
    "a": 1
  },
  "contentDataTypeEnabledWired": true,
  "textFeedsDataTypeEnabledWired": true,
  "healthDataTypeEnabledWired": true,
  "mediaFeedsDataTypeEnabledWired": true,
  "logUploadsXfersEnabledWired": true,
  "contentDataTypeEnabledWireless": true,
  "textFeedsDataTypeEnabledWireless": true,
  "healthDataTypeEnabledWireless": true,
  "mediaFeedsDataTypeEnabledWireless": true,
  "logUploadsXfersEnabledWireless": true,
  "rateLimitModeOutsideWindow": "default",
  "rateLimitRateOutsideWindow": 0,
  "rateLimitModeInWindow": "unlimited",
  "rateLimitRateInWindow": 0,
  "rateLimitModeInitialDownloads": "unlimited",
  "rateLimitRateInitialDownloads": 0,
  "networkConnectionPriority": "wired",
  "networkDiagnosticsEnabled": false,
  "testEthernetEnabled": false,
  "testWirelessEnabled": false,
  "testInternetEnabled": false,
  "useCustomSplashScreen": false,
  "BrightWallName": "",
  "BrightWallScreenNumber": "",
  "specifyHostname": false,
  "hostname": "",
  "useProxy": false,
  "proxyAddress": "",
  "proxyPort": 0,
  "networkHosts": [],
  "contentDownloadsRestricted": false,
  "contentDownloadRangeStart": 0,
  "contentDownloadRangeEnd": 0,
  "heartbeatsRestricted": false,
  "heartbeatsRangeStart": 0,
  "heartbeatsRangeEnd": 0,
  "useDHCP": true,
  "staticIPAddress": "",
  "subnetMask": "",
  "gateway": "",
  "dns1": "",
  "dns2": "",
  "dns3": "",
  "useDHCP_2": true,
  "staticIPAddress_2": "",
  "subnetMask_2": "",
  "gateway_2": "",
  "dns1_2": "",
  "dns2_2": "",
  "dns3_2": "",
  "rateLimitModeOutsideWindow_2": "default",
  "rateLimitRateOutsideWindow_2": 0,
  "rateLimitModeInWindow_2": "unlimited",
  "rateLimitRateInWindow_2": 0,
  "rateLimitModeInitialDownloads_2": "unlimited",
  "rateLimitRateInitialDownloads_2": 0,
  "usbUpdatePassword": "",
  "remoteDwsEnabled": true
}

________________________________________________________

Respuesta correcta

200: El paquete Setup existente se ha modificado correctamente

Respuesta de error

400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos

401: El token de acceso no es válido o no se ha especificado

403: El token de acceso proporcionado, aunque 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/

Elimina un paquete Setup existente con el ID especificado del servidor B-Deploy

Parámetro de cadena de consulta

_id string required: El identificador único de la configuración del dispositivo que se eliminará

Ejemplo de solicitud

_id está establecido en 1a2b3c4d5e6f7a8b9c0d1e2f

DELETE /rest-setup/v3/setup/?_id=1a2b3c4d5e6f7a8b9c0d1e2f HTTP/1.1
Host: provision.bsn.cloud
Authorization: {{Bearer Token}}
Content-Type: application/json
Accept: application/json

___________________________________________________

Respuesta correcta

200: El paquete Setup especificado se ha eliminado correctamente

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 válido, no proporciona acceso a este método

5XX: Cualquier código 500 es un error interno del servidor