Cozify OneAPI (1.0)

Terminology

If you are new to Cozify Services, there are some terms you might not be familiar with.

• resource - A manageable item that is available through Cozify. Hubs, devices and sites are examples of resources. Resource groups, subscriptions and tags are also examples of resources.
• resource group - A container that holds related resources for an Cozify solution. The resource group includes those resources that you want to manage as a group. You decide which resources belong in a resource group based on what makes the most sense for your organization.
• resource provider - A service that supplies Cozify resources. For example, a common resource provider is Cozify.Sites, which supplies the structural management of site (aka. Buildings) resource. Cozify.Devices is another common resource provider.

Receiving events from server using SignalR

In addition to the REST endpoints described here, there is also SignalR hub for streaming device events and managing event subscriptions at /hub/v1 endpoint. See the following page for more information about SignalR streams and how to use them with a .NET/JavaScript/Java client: https://learn.microsoft.com/en-us/aspnet/core/signalr/streaming

1. In order to be able to receive events from the hub, you must open the event stream, otherwise no events will be delivered regardless of subscriptions:

• The device events stream name is DeviceEventsStream
  • The event type DeviceEvent is defined in this OpenApi document
• For instructions how to use the server-to-client streaming sections in this article

2. To manage event subscriptions there are the following methods:

• DeviceEventsSubscribeAll(string deviceRegisterId)
  • Subscribe to events from all devices in the register
• DeviceEventsUnsubscribeAll(string deviceRegisterId)
  • Unsubscribe from all device events from the register
• DeviceEventsSubscribe(SubscribeDeviceEvents subscribeRequest)
  • Subscribe to events from specific devices in the register
  • The SubscribeDeviceEvents type is defined in this OpenApi document.
  • WARNING: If previously subscribed to all events from the same register, this does not change anything; You will still receive events from all devices
• DeviceEventsUnsubscribe(UnsubscribeDeviceEvents unsubscribeRequest)
  • Unsubscribe from specific devices from the register
  • The UnsubscribeDeviceEvents type is defined in this OpenApi document.
  • WARNING: If previously subscribed to all events from the same register, this does not change anything; You will still receive events from all devices
    • Use DeviceEventsUnsubscribeAll instead in this case

Note

Cozify will only support Transport Layer Security (TLS) 1.2 or later.