Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Control Cloud Library

The Postman library for BSN Control Cloud allows you to quickly familiarize yourself with the different APIs and processes associated with a BSN Control Cloud subscription. Follow the below steps to create a person/network, create a player setup, and provision a player on your network with the player setup.

This is a collection of sample endpoint calls to introduce users to our infrastructure.

It is not a comprehensive document of our available endpoints. Please see the BSN.cloud, Remote DWS, and B-Deploy endpoint documentation for a complete list of those endpoints and their usage.

Prerequisites

  • A client ID and client secret (provided by BrightSign)

  • Postman

  • The BSN Control Cloud Library collection and bsn-control-cloud-production environment 

  • A BrightSign player with an active internet connection

Steps

  1. Import both the Control Cloud Library collection and the bsn-control-cloud-production environment into Postman.

  2. Set the Postman environment to bsn-control-cloud-production using the dropdown menu in the top right.

  3. Select the "eye" icon and select Edit to edit the following variables (variables that are not listed here will get their values from Postman scripts):

    • partnerLogin: The email address to use for your BSN.Cloud person credentials

    • partnerEmail: This email address, which should be the same as the Partner Login for now

    • partnerFirstName: Your first name

    • partnerLastName: Your last name

    • networkName: The name of the BSN.cloud network to create. This name must be unique within the BSN.cloud database. You can change this value later on if you want to create multiple networks to work with (for example, for different customers).

    • clientId: Provided by BrightSign

    • clientSecret: Provided by BrightSign

    • playerSerial: The serial number of the player you want to provision for your BSN.cloud network.

    • playerModel: The model number of the player (for example, "XD1034")

    • deviceName: The device name, which can be arbitrary

    • setupName: The Device Setup object name, which can be arbitrary

    • userAccessTokenLifetime: The amount of time that a full access token for a network remains valid. The default value is 15 minutes.

  4. Go to BSN > User/Self > POST Self. Select Send to register with BSN.cloud. This call also returns your person credentials and an auto-generated password, which Postman will store.

  5. Verify your email address:

    • BSN.cloud will send an email to your email address. This may take a few minutes. Click the link in the email to verify the address.

    • You don't need to follow the additional steps in the UI to create a network. These steps will be performed using APIs in the next steps.

  6. Select the Token (Self) call in the root of the library. Select Send to get a "Self" auth token, which Postman will store.

  7. Go to BSN > User/Self > POST Self/Networks. Select Send to create a BSN.cloud network with your credentials as the network owner.

  8. Select the Token (Full) call in the root of the BSN Control Cloud Library. Click Send.

    • The server will return a "Full" auth token, which Postman will store. This token will give you access to the network you created.

    • You may need to renew the "Full" access token periodically by repeating this step. The default timeout for the token is 15 minutes.

  9. Select the Token (device registration) call in the root of the BSN Control Cloud Library. Click Send.

    • The server will return a "device registration" auth token, which Postman will store.

    • The "device registration" token is separate from a user token and allows players to provision themselves for a certain network.

  10. Go to B-Deploy > POST /setup/. Select Send to post a setup to the B-Deploy server and get the setup ID, which Postman will store.

  11. Go to B-Deploy > POST /device/. Select Send. Your device serial number is now associated with the ID of the device setup you created in the previous step.

  12. Power on or reboot your player. The player will reboot several times while provisioning itself for your network.

  13. Go to BSN > Devices > GET Devices. Select Send to get a list of the players on your network.

  14. Go to Remote DWS > GET /info/. Select Send to get the current operational information for the player.

  • No labels