Colecciones de Postman
10 min
esta es una colección de llamadas de endpoint de ejemplo para presentar a los usuarios nuestra infraestructura no es un documento completo de nuestros endpoints disponibles consulte la documentación de endpoints de bsn cloud docid\ htjt91tjlkym96cdoxsds , dws remoto docid\ fy7ynorkjn664uxdkkwjn , y b deploy/provisioning docid 1is4 wl6mcli4d1t5lyda para obtener una lista completa de esos endpoints y su uso requisitos previos una cuenta de postman si es necesario, vaya a este sitio https //www postman com/downloads/ para descargar postman y crear una cuenta gratuita un reproductor brightsign con una conexión activa a internet una cuenta de bsn cloud con al menos una red acceso a control bsn cloud https //control bsn cloud los dos archivos a continuación crear credenciales de cliente antes de poder usar las apis, debe crear una application en control bsn cloud https //control bsn cloud para obtener un client id y un client secret consulte aplicaciones docid\ gi3blfto5agkznmikcwqz para obtener instrucciones los client secrets vencen cada 180 días configure un recordatorio para rotarlos antes del vencimiento importar la colección y el entorno importar el entorno abra postman y seleccione importar en la parte superior izquierda arrastre y suelte (o busque) el archivo bsn cloud production postman environment json seleccione importar para confirmar importar la colección seleccione importar nuevamente arrastre y suelte (o busque) el archivo bsn cloud api 2022 06 postman collection json seleccione importar para confirmar activar el entorno seleccione bsn cloud production en el menú desplegable del entorno en la esquina superior derecha (puede mostrar "no environment"), como se muestra en la imagen 1 el entorno ahora está activo todas las referencias {{variable}} en la colección se resolverán usando estos valores configurar variables de entorno haga clic en el icono de ojo junto al menú desplegable del entorno para ver y editar sus variables de entorno debe establecer algunos valores antes de realizar solicitudes variables requeridas variable qué ingresar ejemplo clientid su client id del admin panel a1b2c3d4 e5f6 7890 abcd ef1234567890 clientsecret su client secret del admin panel abcdefghijklmnopqrstuvwx networkname el nombre de la red con la que desea trabajar mycompanynetwork variables opcionales (configúrelas según sea necesario) variable propósito networkid id numérico de la red (alternativa a networkname) playerserial número de serie de un reproductor (para solicitudes de dws y dispositivos) playermodel cadena del modelo del reproductor (para b deploy) devicename nombre para un dispositivo (para b deploy) setupname nombre del paquete de configuración de b deploy partnerlogin su correo electrónico de inicio de sesión de bsn cloud (para solicitudes de b deploy) applicationid id de la aplicación para la rotación de secretos (no el client id) variables autocompletadas token establecido por "get access token" setupid establecido por "post /setup/" deviceid establecido por "post /device/" deviceregtoken , deviceregtokenscope , deviceregtokenvalidfrom , deviceregtokenvalidto establecido por "get device registration token" ingrese valores en la columna current value (no en la columna initial value) para mantener sus credenciales locales y evitar que se sincronicen con la nube de postman flujo de trabajo de autenticación la api de bsn cloud utiliza un proceso de autenticación de dos pasos debe completar ambos pasos antes de realizar cualquier otra llamada a la api paso 1 obtener un token de acceso en la barra lateral de la colección, expanda la carpeta autenticación seleccione obtener token de acceso haga clic en enviar esto envía una solicitud publicar al servidor de autenticación de brightsign mediante el flujo oauth2 client credentials la solicitud usa autenticación http basic con su client id y client secret (gestionados automáticamente por la pestaña de autenticación de postman) si se realiza correctamente, el script de prueba guarda automáticamente el access token en la variable de entorno {{token}} paso 2 configurar la red seleccione establecer red (por nombre) (o establecer red (por id) si lo prefiere) seleccione enviar esto le indica a la api de bsn cloud con qué red desea trabajar en esta sesión la solicitud usa el token obtenido en el paso 1 una respuesta http 204 sin contenido con cuerpo vacío es normal y significa que la operación fue exitosa después de que ambos pasos se completen correctamente, todas las demás solicitudes de la colección funcionarán usando la variable {{token}} que se configuró automáticamente cada vez que obtenga un nuevo token de acceso, debe configurar la red nuevamente el token expira después de 5 minutos 30 segundos , pero la sesión de red dura 24 horas solución de problemas no se pudo obtener ninguna respuesta" o tiempo de espera de conexión verifique que tenga conectividad a internet compruebe que las url de su entorno sean correctas (haga clic en el ícono del ojo para verificarlo) asegúrese de que su firewall/proxy corporativo permita conexiones a bsn cloud 204 no content en set network (pero las llamadas posteriores fallan) el nombre de la red puede estar mal escrito los nombres distinguen entre mayúsculas y minúsculas verifique que la red exista y que su cuenta tenga acceso a ella pruebe establecer red (por id) en lugar del id numérico de la red 400 bad request en set network la red especificada no existe o usted no tiene acceso a ella vuelva a comprobar el valor de networkname o networkid en su entorno 401 unauthorized en get access token vuelva a comprobar los valores de clientid y clientsecret en el entorno (busque espacios adicionales o caracteres faltantes) verifique que su client secret no haya expirado (límite de 180 días) si expiró ejecute obtener token de acceso nuevamente ejecute configurar red nuevamente reintente la solicitud original asegúrese de ingresar los valores en la columna current value 401 unauthorized en otras solicitudes su token de acceso ha expirado (tiene una duración de cinco minutos y 30 segundos) debe ejecutar obtener token de acceso y configurar red nuevamente asegúrese de que el menú desplegable de entorno (arriba a la derecha) esté configurado en bsn cloud production 403 prohibido su aplicación no tiene el alcance requerido para esta llamada de api vaya al admin panel, edite su application y agregue las funciones necesarias luego obtenga un nuevo token de acceso (los cambios de alcance no surten efecto en los tokens existentes) debe pertenecer a la misma red bsn cloud que el reproductor si le envía mensajes usando las remote dws apis 404 no encontrado compruebe que la ruta de url sea correcta