Overview

This document covers the current latest version of the "Device API" which is at version #1. (Denoted by the usage of v1 in all API urls). While the main functionality of the API does not change, small updates are made from time to time to improve the usability of the system. To allow for this, a "XYTE API Version" is set for each Device Model in the Partner Portal and affects how the Xyte APIs respond to Device requests.

Version Management

During a Device Model creation, the "XYTE API Version" (aka version) is set to either:

1. Automatically to highest version between all the current models the partner defined
2. Automatically, If this is first Device Model created, to the highest current version supported
3. Manually by the user

The above is done to ensure that if the same firmware, compatible with version x.y.z is already used on other Device Models, it will correctly work for the newly setup one as well.

The creation dialog allows changing the version, with the latest being the most recommended.

To change the version after Device Model creation, please contact support.

Change Log

v1.0.7 (latest)

• Added the device_id field to be returned by the following APIs (HTTP & MQTT)
  • Get Incidents
  • Get Licenses
  • Get License
  • Get Config
  • Get Space Info
  • Get Command

v1.0.6

• The Update Device API accepts only supported parameters and returns an error 400 if an unknown parameter was passed.

v1.0.5

• The Get Config API and Set Config APIs return the configuration scoped instead of merged with server parameters

{
  "version": 10,
  "last_updated": ....,
  ..configuration fields..
}

{
  "name": ...,
  "version": ...,
  "last_updated": ...,
  "config": { ..configuration fields.. }
}

v1.0.4

• Require firmware versions to be in the Semantic Versioning format.

v1.0.3

• The hub_url parameter returned by Register Device API and Register Child Device API, must be used for all following communications with the server, instead of entry.xyte.io

v1.0.2

• The Register Device API requires the sn (Serial Number) parameter, even when using “CloudID” Device Authentication.

V1.0.1

• The Update Command API now requires the original command's ID to be passed as the id parameter. (Previously it automatically references the command at the head of the queue).