APIs DWS locales
El acceso local (es decir, el acceso a través de la red local) al Diagnostic Web Server (DWS) está deshabilitado de forma predeterminada a partir de BrightSignOS 9.0.218 (en la rama 9.0) y BrightSignOS 9.1.75 (en la rama 9.1). En las versiones de BrightSignOS anteriores a estas, el acceso local al DWS estaba habilitado de forma predeterminada. Para habilitar el acceso local al DWS, consulte DWS: Acceso localDWS: Local Access.
Tenga en cuenta que algunos reproductores configurados especialmente tienen el puerto de tarjeta microSD externa y el almacenamiento USB deshabilitados de fábrica (SKU: SVC-internal-storage-only). Para estos reproductores, el acceso local al DWS permanece habilitado de forma predeterminada.
El acceso remoto (es decir, el acceso a través de internet) al DWS sigue estando disponible para todos los reproductores conectados a internet registrados en BrightSign Cloud.
Hay dos maneras de acceder a estas APIs:
- Puede optar por usar autenticación digest. La autenticación digest utiliza un nombre de usuario y una contraseña. El nombre de usuario siempre es “admin”. La contraseña se puede establecer de tres maneras:
- Usar la predeterminada, que es el número de serie del reproductor
- Establecerla mediante el paquete de configuración
- Establecerla usando un script personalizado
- Puede optar por usar sin autenticación. Sin embargo, esto no se recomienda.
Una vez que se establece la contraseña, necesita autenticarse para acceder a las APIs del DWS local. Para hacer esto:
- Debe usar BrightSignOS 8.4.6 o una versión posterior.
- Llame a la API deseada usando autenticación digest con el nombre de usuario y la contraseña del DWS local. Tenga en cuenta que la autenticación digest es bastante insegura cuando se usa sobre un transporte inseguro (HTTP).
El prefijo de URL es siempre https://player_ip/api
Definiciones de APIefinit
Las APIs enumeradas tienen el prefijo de versión /v1. No podemos garantizar que estos documentos estén actualizados en todos los casos.
Uso de HTTPS con el DWS local
En las versiones de BOS posteriores a BOS 8.2.35.4, los usuarios tenían la opción de usar un certificado de confianza o un certificado autofirmado para acceder a HTTPS a través del DWS. A partir de BOS 9.0.218 y 9.1.52, el DWS local usa HTTPS de forma predeterminada con un certificado autofirmado. Anteriormente (en BOS 8.2.35.4 y versiones más recientes) HTTPS era opcional, pero se debía proporcionar un certificado autofirmado. Consulte Agregar certificados digitales para obtener información sobre cómo aplicar un certificado a un reproductor.
Si sus scripts existentes usan HTTP para acceder a LDWS, debería actualizarlos para usar HTTPS. Si no es posible actualizar los scripts de inmediato, puede establecer temporalmente la clave de registro enable_http_redirect en la sección networking en false (enlace al documento del registro). Esto deshabilita la redirección HTTP, permitiendo que sus scripts actuales continúen funcionando.
Tenga en cuenta que HTTPS se aplica independientemente de la configuración de la clave de registro. La clave de registro solo controla el comportamiento de redirección HTTP y no deshabilita la aplicación de HTTPS.
Generación de un certificado y una clave autofirmados
Para hacer esto, elija uno de los siguientes dos métodos:
- Ejecute este código:
openssl req -nodes -new -x509 -keyout dws.key -out dws.crt- O ejecute el siguiente código y use los archivos 'dws.key' y 'dws.crt'. Los otros archivos pueden eliminarse más tarde.
openssl req -newkey rsa:4096 -keyform PEM -keyout ca.key -x509 -days 3650 -outform PEM -out ca.cer
openssl genrsa -out dws.key 4096
openssl req -new -key dws.key -out client.req
openssl x509 -req -in client.req -CA ca.cer -CAkey ca.key -set_serial 101 -extensions client -days 365 -outform PEM -out dws.crtHacer accesibles los archivos de certificado y clave
El sistema operativo buscará archivos con nombres conocidos en la raíz del almacenamiento predeterminado. Para que los archivos de certificado y clave que generó puedan encontrarse, haga una de las siguientes acciones:
- Asigne a los archivos los nombres dws.crt y dws.key, como en los ejemplos.
- Coloque los nombres de los archivos en el registro networking usando las claves ldws_cert_file_name, ldws_key_file_name. Consulte Claves del registro de BrightSign para obtener más información.
Si desea proporcionar el certificado CA, puede usar el nombre predeterminado dws.ca o, si desea usar otro nombre, use la clave de registro ldws_ca_file_name para especificar el nombre del archivo.
Luego coloque los archivos en la raíz del almacenamiento predeterminado. Si ha definido la clave de registro ldws_certs_path registry key, esta será la ubicación de los certificados (en lugar del almacenamiento predeterminado).