Request a websocket data stream, and commands to manage the data stream

Request ticket and meta data:

https://api.eze.io/v1/subscribe/ticket

The subscribe/ticket call requests a websocket ticket and returns metadata for the group and ezeio units that are in context of the given API credentials.

Subsequent calls using the subscribe command are used to manage the data stream.

The subscribe/ticket call has no parameters

Using the subscribe API requires the following steps:

Step 1 : Request ticket and metadata

Call the following API endpoint using valid API credentials:

https://api.eze.io/v1/subscribe/ticket

This call will return a JSON object (see example below) with metadata listing the systems that will be accessible through the websocket.

(whitespaces for readability)

{
	"reqtime": "2021-01-31T14:15:16Z",
	"ws": "wss:\/\/api.eze.io\/ws\/wstktXXXXXXXXXXXXXXXXXXXXXXX",
	"api": "https:\/\/api.eze.io\/v1\/subscribe\/wstktXXXXXXXXXXXXXXXXXXXXXXX\/",
	"account": {
		"id": "123",
		"name": "eze System",
		"description": "eze System - Testaccount"
	},
	"systems": [{
			"serial": "ABC-123",
			"name": "Demo unit",
			"note": "This is a demo unit in our lab",
			"lastseen": "2021-01-31T14:10:11Z",
			"fields": [{
				"fieldno": "1",
				"name": "Tank Level: Distance from top",
				"unit": "in",
				"decimals": "2",
				"assettag": "TANKLVL",
				"loginterval": "0"
			}, {
				"fieldno": "2",
				"name": "Output flow",
				"unit": "gal/min",
				"decimals": "1",
				"assettag": "",
				"loginterval": "60"
			}]
		},
		{
			"serial": "ABC-456",
			"name": "Other demo unit",
			"note": "This is also a demo unit in our lab",
			"lastseen": "2021-01-31T14:09:56Z",
			"fields": [{
				"fieldno": "2",
				"name": "Air temperature",
				"unit": "F",
				"decimals": "1",
				"assettag": "",
				"loginterval": "300"
			}, {
				"fieldno": "3",
				"name": "Relative humidity",
				"unit": "percent",
				"decimals": "0",
				"assettag": "",
				"loginterval": "0"
			}, {
				"fieldno": "4",
				"name": "Voltage",
				"unit": "V",
				"decimals": "1",
				"assettag": "V",
				"loginterval": "0"
			}]
		}
	],
	"status": "OK",
	"exec_time": 0.055
}

The ws property is the complete websocket URI. This URI is valid only for 10 seconds following the call to subscribe/ticket.

Step 2 : Open websocket and start receiving data

Use the ws URI from step 1 to open a websocket connection. The websocket will automatically receive all updates to any system (ezeio) covered by the initial API call, as the data becomes available to the cloud servers.

The data received will have a type, describing what kind of data this is:

Note that the ezeio normally buffers data before the data is uploaded to the cloud servers, so the data may be delayed with up to 20 minutes

Step 3 : Request immediate updates or cancel subscription Call subscribe with

JSON formatted data from the subscribe/ticket call: