API Reference

Integration flow

Overview

The Cloud-2-Cloud (C2C) integration follows two main steps:

  1. Connect devices to the Xyte cloud
  2. Assign devices to an Xyte tenant

User Flow

This is the recommended from for a User connecting to the OEM's Cloud and adding the Xyte integration.

  1. User logs into the OEM cloud
  2. User selects the add "Xyte Integration" option
  3. The system shows the user helpful information on how to
    1. Sign-up or sign-in to the Xyte Cloud
    2. Obtain an API key
  4. The User copies the API key and enabled the integration
  5. The C2C integration registers devices with the Xyte cloud and starts sending data (telemetries, etc)
  6. The C2C integration copies the "space" (location/container/etc) structure to the User's Xyte tenant via the "Space Management APIs"
  7. The C2C integration assigns devices to the User's Xyte tenant

APIs and Flows

Device Registration and Data

The device registration and data flow, follows the same integration principles as the integration for native devices.

  1. Register devices with Xyte Register Device
  2. Continuously send telemetries Send Telemetry
  3. Any other advanced integrations, such as Commands, Configuration, Events, etc.

Space Management

The space and assignment/claiming APIs are based on the "End Customer" APIs that are accessible using the "API Token" obtained from the User's Xyte tenant (Step #4 in the "User flow" above).

Space creation and manipulation can be done via:

Device Assignment

Devices that register with the Xyte cloud are not automatically assigned to a tenant and must be explicitly tied to the User's Xyte tenant via

Demo

Full demo flow