CloudFlow Device API API Reference

CloudFlow enables devices to receive requests from a connected client.

Contact: info@aevi.com
Request Content-Types: application/json
Response Content-Types: application/json
Version: 1

Authentication

apiToken

type
http
scheme
bearer
bearerFormat
base64({"model": "Device model", "serialNumber": "Device serial number", "apiToken": "Device API token"})

Paths

GET /devices/enrol

Enrols a device for communication via websockets.

This returns the relevant details for connecting and authenticating a websocket against CloudFlow.

401 Unauthorized
403 Forbidden
Response Content-Types: application/json
Response Example (200 OK)
{
  "connectionType": "string",
  "connectionUrl": "string",
  "tokenType": "string",
  "accessToken": "string"
}
Response Example (401 Unauthorized)
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (403 Forbidden)
{
  "errorCode": "string",
  "errorMessage": "string"
}

Schema Definitions

CredentialsConnectionType: string

The connection type. Supported values are: ['websocket'].

string websocket

CredentialsTokenType: string

The type of access token provided. Supported values are: ['jwt'].

string jwt

ConnectionCredentials: object

Represents connection credentials required to connect to CloudFlow.

connectionType: CredentialsConnectionType

The connection type. Supported values are: ['websocket'].

connectionUrl: string

The websocket URL to connect to.

tokenType: CredentialsTokenType

The type of access token provided. Supported values are: ['jwt'].

accessToken: string

An access token to use for authentication when connecting to the websocket.

Example
{
  "connectionType": "string",
  "connectionUrl": "string",
  "tokenType": "string",
  "accessToken": "string"
}

ApiError: object

Represents a CloudFlow API error.

errorCode: string

The error code.

See documentation for a list of possible error codes and what they represent.

errorMessage: string

A description of the error that occurred.

Example
{
  "errorCode": "string",
  "errorMessage": "string"
}