Cloud

API for communication with ZBOS by Zora Robotics.

Channels

zbos/cloud/login

PUB Login to the cloud

see zbos/cloud/login/response for response

Channel tags

  • Cloud

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/cloud/login/response

SUB response: Login to the cloud

Response indicating if login to the cloud was successful or not

Channel tags

  • Cloud

LoginResponse
Payload

Name

Type

Description

Accepted values

token

string

jwt auth token

Any

success

boolean

Any
Examples of payload
{
  "token": "string",
  "success": true
}

zbos/cloud/config/get

PUB Get cloud config

see zbos/cloud/config/response/{key} for response

Channel tags

  • Cloud

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/cloud/config/response/{key}

SUB response: Get cloud config

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/cloud/config/set

PUB Set cloud config

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/cloud/config/event

SUB event: Config cloud

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/media/library/resync

PUB Resync all media libraries

see zbos/media/library/resync/response/{key} for response

Channel tags

  • Cloud

EmptyMessage

Empty message

zbos/media/library/resync/response/{key}

SUB response: Resync all media libraries

Channel tags

  • Cloud

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/media/library/file/upload

PUB Upload file in media library

see zbos/media/library/file/upload/response/{key} for response

Channel tags

  • Cloud

FileUploadRequest
Payload

Name

Type

Description

Accepted values

file

string

Any

storageAccount

string

Any

key

string

Any

metadata

object

Any
Examples of payload
{
  "file": "string",
  "storageAccount": "string",
  "key": "string",
  "metadata": {}
}

zbos/media/library/file/upload/response/{key}

SUB response: Upload file in media library

Channel tags

  • Cloud

CloudResult
Payload

Name

Type

Description

Accepted values

success

boolean

Any

cloudFileId

string

Any
Examples of payload
{
  "success": false,
  "cloudFileId": "string"
}

zbos/cloud/user/list

PUB Request users linked to the robot

Channel tags

  • Cloud

LinkedUsersRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

offset

number

Any

limit

number

Any
Example of payload (generated)
{
  "key": "string",
  "offset": 0,
  "limit": 0
}

zbos/cloud/user/list/response/{key}

SUB response: users linked to the robot

Channel tags

  • Cloud

LinkedUsersResponse
Payload

Name

Type

Description

Accepted values

accounts

array (object)

Any

accounts. id

string

Any

accounts. username

string

Any

accounts. email

string

Any

accounts. picture

string

Any

accounts. admin

boolean

Any

accounts. mqttAccount

string

Any

offset

number

Any

limit

number

Any

numResults

number

Any
Examples of payload
{
  "accounts": [
    {
      "id": "cffb2596-662f-479a-8f43-af1651a61c6d",
      "username": "John Doe",
      "email": "someone@zorabots.be",
      "picture": "https://lh3.googleusercontent.com/a/AATXAJy1DGqwgHZMEiiz=s96-c",
      "admin": true,
      "mqttAccount": "c-1b32e964-0d76-4ce4-bc61-f8e05bdcebf9"
    }
  ],
  "offset": 0,
  "limit": 20,
  "numResults": 1
}

zbos/cloud/license/list

PUB Request a license list for the robot

Channel tags

  • Cloud

LicenseListRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

offset

number

Any

limit

number

Any
Example of payload (generated)
{
  "key": "string",
  "offset": 0,
  "limit": 0
}

zbos/cloud/license/list/response/{key}

SUB response: Request linking a user to the robot

Channel tags

  • Cloud

LicenseListResponse
Payload

Name

Type

Description

Accepted values

licenses

array (object)

Any

licenses. id

string

Any

licenses. serial

string

Any

licenses. softwareId

string

Any

licenses. createdTimestamp

integer

Any

licenses. type

string

Any

licenses. validFrom

integer

Any

licenses. validUntil

integer

Any

offset

number

Any

limit

number

Any

numResults

number

Any
Examples of payload
{
  "licenses": [
    {
      "id": "7c18ae59-1d2c-4fbb-b7e8-4f07fd7b20d4",
      "serial": "SH- J02 000596",
      "createdTimestamp": 1618783200,
      "type": "LICENSE_TYPE_ROBOT",
      "validFrom": 1618783200,
      "validUntil": 1651017599
    },
    {
      "id": "7c18ae59-1d2c-4fbb-b7e8-4f07fd7b20d4",
      "serial": "SH- J02 000596",
      "softwareId": "73143543-98bf-4ac6-8992-d8b097bbea27",
      "createdTimestamp": 1623329499,
      "type": "LICENSE_TYPE_SOFTWARE",
      "validFrom": 1623276000,
      "validUntil": 1654984799
    }
  ],
  "offset": 0,
  "limit": 20,
  "numResults": 2
}