BSN.cloud API Reference#

Complete reference for the BSN.cloud REST API.

Base URLs#

ServiceURL
Main APIhttps://api.bsn.cloud/2022/06/REST
Authhttps://auth.bsn.cloud
B-Deployhttps://provision.bsn.cloud
Remote DWShttps://ws.bsn.cloud

Authentication#

Get Access Token#

POST https://auth.bsn.cloud/realms/bsncloud/protocol/openid-connect/token Basic Auth

Request:

Content-Type: application/x-www-form-urlencoded
Authorization: Basic {base64(clientId:clientSecret)}

grant_type=client_credentials

Response:

1
2
3
4
5
{
    "access_token": "eyJhbG...",
    "expires_in": 330,
    "token_type": "Bearer"
}

Set Network Context#

PUT /Self/Session/Network Bearer Token
1
{ "id": 12345 }

Devices#

List Devices#

GET /Devices Bearer Token

Query Parameters:

  • $filter - OData filter expression
  • $orderby - Sort field
  • $top - Max results
  • $skip - Offset for pagination

Get Device#

GET /Devices/{id} Bearer Token

Reboot Device#

POST /Devices/{id}/Reboot Bearer Token

Take Screenshot#

POST /Devices/{id}/Snapshot Bearer Token

Content#

List Content#

GET /Content Bearer Token

Upload Content#

POST /Content Bearer Token
1
2
3
4
{
    "name": "video.mp4",
    "fileSize": 1234567
}

Delete Content#

DELETE /Content/{id} Bearer Token

Presentations#

List Presentations#

GET /Presentations Bearer Token

Publish Presentation#

POST /Presentations/{id}/Publish Bearer Token

Users#

List Users#

GET /Users Bearer Token

Get Current User#

GET /Self Bearer Token

Response Codes#

CodeMeaning
200Success
201Created
204No Content (success)
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Rate Limits#

  • 100 requests per minute per token
  • 1000 requests per hour per application

For detailed API documentation, see BSN.cloud APIs.