B-Deploy Setup Endpoints (v3)
- BrightSign TechDocs
These endpoints allow users to automatically provision BrightSign players over the internet. This endpoint handles everything regarding individual players. Add your serial number to BrightSign’s cloud storage with an associated player name, provisioning package name, and the URL where the provisioning package is hosted. The URL is optional - it can be left blank if using a setup package.
Version 3.0 of these APIs contains additional support for multiple network interfaces through the Network object.
Base URL for these endpoints: https://provision.bsn.cloud/rest-setup/v3/setup/
_____________________________________________________________
GET /
Returns a list of setup records in the exact format they are stored in the B-deploy database. The main setup values are stored in each array object in the “setupJson” parameter.
If you want to get information about a specific B-Deploy setup, see :_id/ GET
Query String Parameter
NetworkName string required
The user-defined name of the bsn.cloud network
username string optional
The name of the user who created the setup package
packageName string optional
The user-defined name of the setup package.
Example Request
curl --location
--request GET 'https://provision.bsn.cloud/rest-setup/v3/setup?NetworkName=anon&username=testuser@email.com' \
--header 'Authorization: Bearer {{token}}'________________________________________________________
Success Response Body
200: Returns an array of the following information for each setup in the network:
_id string
The system-supplied id of the device setup
updatedAt string
A UTC timestamp indicating when the device setup was last modified.
createdAt string
A UTC timestamp indicating when the device setup was created.
username string
The bsn.cloud username
client string
The client id of the bsn.cloud server
packageName string
The client-defined name for the device setup package. This value must be unique among device setup packages that belong to your person entity.
setupType string
The device setup type (either "lfn", "sfn", "partner", "standalone", or "bsn")
version string
The B-Deploy cloud version. This value should be "3.0.0"
networkName string
The BSN.cloud network name
deviceName string
The user-defined device name
deviceDescription string
The user-defined device description
bsnGroupName string
The bsn.cloud group name
setupJson DeviceSetup{}
A Device Setup Entity (v3), which contains all of the setup parameters in stringified JSON
Failure Response
400: The request is malformed and therefore invalid (for example, NetworkName is not specified)
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method. The access token used to call this /v3/setup API must belong to the same network.
5XX: Any 500 code is an internal server error
POST /
Adds device setups to the B-Deploy server
Request Body
Example Request
curl --location
--request POST 'https://provision.bsn.cloud/rest-setup/v3/setup?query%5BnetworkName%5D=Test' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'\
--data-raw '{exampleDeviceSetupObject}'Note that the data-raw flag allows a request body to be passed and exampleDeviceSetupObject is a placeholder for a device setup object.
________________________________________________________
Success Response Body
201: The id of the device setup object
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
415: The server cannot accept the data representation that you sent (as specified in the header)
5XX: Any 500 code is an internal server error
PUT /
Updates existing device setups on the B-Deploy server.
Request Body
DeviceSetup object
Example Request
curl --location
--request PUT 'https://provision.bsn.cloud/rest-setup/v3/setup?username=example@gmail.com' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'\
--data-raw '{exampleDeviceSetupObject}'The data-raw flag allows a request body to be passed and exampleDeviceSetupObject is a placeholder for a device setup object.
________________________________________________________
Success Response
200: The existing device setup has been updated
Failure Response
400: Either the request or request body is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
415: The server cannot accept the data representation that you sent (as specified in the header)
5XX: Any 500 code is an internal server error
DELETE /
Deletes a device setup from the B-Deploy server.
Query String Parameter
_id string required
The id of the device setup to delete
Example Request
___________________________________________________
Success Response
200: The specified device setup has been removed
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
5XX: Any 500 code is an internal server error
GET /:_id/
Retrieves the device setup from the B-Deploy server for one specified setup id.
Route Parameter
_id string required
The database id of the device setup you want to retrieve. This "id" is returned in the response to /rest-setup/v3/setup/POST, above.
Example Request
________________________________________________________
Success Response Body
200: Returns an empty array of device setup errors and the Device Setup Entity (v3)
Failure Response
400: The request is malformed and therefore invalid
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method. The access token used to call this /v3/setup API must belong to the same network.
5XX: Any 500 code is an internal server error