Puntos de conexión del registro LDWS

24 min

GET /v1/registry/

Devuelve el volcado completo del registro. Las secciones ocultas del registro no se devuelven en esta respuesta.

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

GET /api/v1/registry/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

éxito bool: Si la operación es exitosa
valor object: Las claves son los nombres de las secciones del registro. Estos son algunos ejemplos:
- brightscript string: Los pares clave-valor de BrightScript
- redes string: Los pares clave-valor de networking

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "value": {
        "autorun": {
          "bootchecks": "",
          "bootstrap": "",
          "knowngood": "",
          "lasttried": ""
        },
        "brightscript": {
          "createdby": "Supervisor 2.1.10"
        },
        "networking": {
          "a": "JaneDoeTesting",
          "access_token": "JcqVLXY3Ttpkpc5IiWL7wMHibKKcLDJkuRaLgWBQyvcjdI2JYRjHDdjaHQrnGkm9b9wAbdb2kTqqCC02oKjA7EJZMfP1jyllrbdFrscXbXePr4WtV3TRYoiWtv8tRGVB",
          "access_token_expiration": "86400",
          "access_token_expires_at": "Thu Feb 08 2024 07:47:26 GMT-0800 (Pacific Standard Time)",
          "bbhf": "true",
          "bph": "[]",
          "brightwallname": "",
          "brightwallscreennumber": "",
          "bs": "/bs/batteryCharger.ashx",
          "bsn_settings_last_modified": "Tue, 30 Jan 2024 22:01:45 GMT",
          "bsnapiversion": "2022/06",
          "cdr": "no",
          "createdby": "Supervisor 2.1.10",
          "cwr": "True",
          "dd": "/bs/devicedownload.ashx",
          "de": "/bs/deviceerror.ashx",
          "dhcp": "yes",
          "dle": "no",
          "dp": "/bs/devicedownloadprogress.ashx",
          "dwse": "true",
          "dwsp": "",
          "ele": "no",
          "enableremotesnapshot": "no",
          "enablewpaenterpriseauthentication": "False",
          "endpoints_blessings_installer_url": "https://certs.bsn.cloud/install-blessing/v1/",
          "endpoints_blessings_server_bp3": "https://certs.bsn.cloud/blessings/",
          "endpoints_bsn_classic_api_server": "http://api.brightsignnetwork.com",
          "endpoints_bsn_classic_server": "https://services.brightsignnetwork.com",
          "endpoints_bsnapiserver": "https://api.bsn.cloud",
          "endpoints_bsnserver": "https://handlers.bsn.cloud",
          "endpoints_certsserver": "https://certs.bsn.cloud",
          "endpoints_echotest": "https://certs.bsn.cloud/echo/ping",
          "endpoints_failsafecheck": "https://certs.bsn.cloud/features/api/v1/failsafe",
          "endpoints_featuresavailable": "https://certs.bsn.cloud/features/api/v1/features",
          "endpoints_provisionserver": "provision.bsn.cloud",
          "endpoints_remote_storage_notifications": "https://certs.bsn.cloud/files/api/v1/notify",
          "endpoints_remote_storage_server": "https://certs.bsn.cloud/files/api/v1/verify",
          "endpoints_s3_classic_url": "http://bsnm.s3.amazonaws.com/public/",
          "endpoints_s3url": "https://bsncloud.s3.amazonaws.com/public/",
          "endpoints_supervisorupgrade": "https://certs.bsn.cloud/features/api/v1/supervisors",
          "endpoints_websocketsdws": "wss://ws.bsn.cloud/",
          "eu": "/bs/error.ashx",
          "g": "Default",
          "hh": "/bs/heartbeat.ashx",
          "hr": "no",
          "hwr": "True",
          "internalcapackages": "",
          "isc": "FF702896",
          "last_modified_autorun_settings_at": "2024-01-30T22:01:45.000Z",
          "lastbsnconnectiontime": "2024/01/30 10:57:50.864",
          "lwr": "True",
          "mwr": "True",
          "ncp": "0",
          "networkjson": "{\"hostname\":\"BrightSign-RE433D006644\",\"proxyServer\":null,\"proxyBypass\":[],\"timeServers\":[\"http://time.brightsignnetwork.com\"],\"interfaces\":[{\"enabled\":true,\"proto\":\"DHCP\",\"ip\":null,\"gateway\":null,\"dns\":null,\"rateLimitDuringInitialDownloads\":0,\"rateLimitInsideContentDownloadWindow\":0,\"rateLimitOutsideContentDownloadWindow\":null,\"contentDownloadEnabled\":true,\"textFeedsDownloadEnabled\":true,\"mediaFeedsDownloadEnabled\":true,\"healthReportingEnabled\":true,\"logsUploadEnabled\":true,\"name\":\"eth0\",\"type\":\"Ethernet\",\"metric\":100}]}",
          "nlws": "s",
          "nlwseun": "yes",
          "nlwsp": "",
          "nlwsu": "",
          "nu": "/bs/checkforcontent.ashx",
          "p": "",
          "ple": "no",
          "rdwse": "yes",
          "refresh_token": "LUi0ZRpbz1BWJ3JuBCwMPtRxEMQ9vMwyTRokUSENNCRckFOuVTUshtfb7Lk5H3Ji8kTyBsqVlwo9SZjzwkHv6V9XKKX4mtwbvGWWlYgUslOK7UbURW3zeMGKWhxbIghx",
          "refresh_token_expires_at": "Fri Feb 06 2026 07:47:26 GMT-0800 (Pacific Standard Time)",
          "registered_with_bsn": "yes",
          "rlmid": "unlimited",
          "rlmiw": "unlimited",
          "rlmow": "default",
          "rlrid": "0",
          "rlriw": "0",
          "rlrow": "0",
          "rs": "/recovery/recovery_runsetup_ba.brs",
          "ru": "/recovery/recovery.ashx",
          "schedule_handler_duration": "21600",
          "settings_handler_duration": "21600",
          "sle": "no",
          "status_handler_duration": "300",
          "sut": "BSN",
          "tbh": " 300",
          "tbnc": " 21600",
          "td": "/bs/trafficdownload.ashx",
          "ts": "http://time.brightsignnetwork.com",
          "twr": "True",
          "tz": "PST",
          "u": "",
          "uab": "no",
          "uat": "no",
          "ub": "https://handlers.bsn.cloud/",
          "ud": "Trying again",
          "ul": "/bs/uploadlogs.ashx",
          "un": "XD5",
          "unm": "appendUnitIDToUnitName",
          "up": "no",
          "ut": " 0",
          "v": "1",
          "version": "3.0.0",
          "vle": "no",
          "vu": "/bs/events.ashx",
          "wifi": "no"
        },
        "newsection": {
          "newkey": "newvalue"
        }
      }
    }
  }
}

GET /v1/registry/:section/:key/

Devuelve un valor de clave particular para una sección y clave especificadas.

Valores de segmento

sección string: El nombre de la sección del registro
clave string: El nombre de la clave del registro

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:

sección está configurado en html
clave está configurado en use-brightsign-media-player

GET /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "section": "brightscript",
      "key": "g",
      "value": ""
    }
  }
}

PUT /v1/registry/:section/:key/

Crea valores de registro. Realice primero un GET para ver qué claves están disponibles.

Las aplicaciones dependen de los valores que han configurado en el registro. Tenga cuidado con las claves del registro que actualiza para evitar poner el reproductor en un estado inestable.

Valores del segmento

sección string: El nombre de la sección del registro (por ejemplo, "html" o "networking")
clave string: El nombre de la clave del registro

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:

sección está configurado en html
clave está configurado en use-brightsign-media-player

PUT /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Content-Type: application/json
Content-Length: 33

Este es el cuerpo de la solicitud de ejemplo:

{
   "value": "0"
}

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "section": "html",
      "key": "use-brightsign-media-player",
      "value": "23"
    }
  }
}

DELETE /v1/registry/:section/:key/

Elimina los valores del registro especificados.

Las aplicaciones dependen de los valores que han configurado en el registro. Tenga cuidado con las claves del registro que elimina para evitar poner el reproductor en un estado inestable.

Valores del segmento

sección string: El nombre de la sección del registro (por ejemplo, "html" o "networking")
clave string: El nombre del valor del registro

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:

sección está configurado en html
clave está configurado en use-brightsign-media-player

DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

éxito bool: Un indicador que indica si la clave del registro fue eliminada
sección string: Este indicador se establece en la sección del registro
clave string: Este indicador se establece en la clave del registro

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "section": "html",
      "key": "use-brightsign-media-player"
    }
  }
}

DELETE /v1/registry/:section/

Elimina una sección completa del registro

Segmento

sección string: El nombre de la sección del registro (por ejemplo, "html" o "networking")

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

sección se establece en test_section

DELETE /api/v1/registry/test_section/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

éxito bool: Un indicador que indica si la sección del registro fue eliminada
sección string: Este indicador se establece en la sección del registro

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "section": "test_section"
    }
  }
}

GET /v1/registry/recovery_url/

Recupera la URL de recuperación almacenada en el registro del reproductor

Ejemplo de solicitud

recovery_url es la URL de recuperación en el registro del reproductor

GET /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Cuerpo de la respuesta

éxito bool: Un indicador que indica si la solicitud se leyó correctamente
valor string: La URL de recuperación

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true,
      "value": "https://handlers.bsn.cloud//recovery/recovery.ashx"
    }
  }
}

PUT /v1/registry/recovery_url/

Actualiza la URL de recuperación en el registro del reproductor.

Cuerpo de la solicitud

url string: El valor de la URL de recuperación

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

url está establecido en www.google.com

PUT /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}}
Accept: application/json
Content-Type: application/json
Content-Length: 37

Cuerpo de la solicitud

{
   "url": "www.google.com"
}

Cuerpo de la respuesta

éxito bool: Un indicador de si la escritura se realizó correctamente

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true
    }
  }
}

PUT /v1/registry/flush/

Vacía inmediatamente el contenido del registro del reproductor en el almacenamiento persistente. Este endpoint solo está disponible en BOS 9.0.107 y 8.5.46 y versiones posteriores.

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo están establecidos de la siguiente manera:

PUT /api/v1/registry/flush/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}}
Accept: application/json

Cuerpo de la respuesta

éxito bool: Un indicador de si el vaciado se realizó correctamente

Ejemplo de respuesta

{
  "data": {
    "result": {
      "success": true
    }
  }
}