CollabOS and Sync Cloud API FAQ
Introduction
Logitech creates innovative tools that empower businesses to work smarter and more efficiently. From personal peripherals to video conferencing solutions, Logitech devices enhance productivity, streamline workflows, and optimize performance, helping you unlock the full potential of your technology investment.
To empower businesses further, Logitech is introducing two powerful APIs: the CollabOS API and the Sync Cloud API. These APIs enable expanded data access, providing the tools you need to create dashboards, monitor device health, track workspace utilization, assess room environmental conditions, and much more.
The CollabOS API is a local-only API designed for local interfacing with CollabOS Appliance devices. This API delivers raw data directly from the device, making it ideal for businesses that prefer on-premises solutions or need to manage a smaller number of devices. The CollabOS API offers a secure, streamlined way to access specific device-level information without relying on the cloud.
The Sync Cloud API allows customers to integrate with Logitech’s cloud platform securely. Through this API, you can access raw data and insights for every device managed within Sync—whether connected via a meeting room computer, a CollabOS Appliance, or associated peripherals. This scalable API is perfect for managing and monitoring large fleets of devices, gaining organization-wide visibility through a single cloud API endpoint.
Used independently or together, the CollabOS API and Sync Cloud API provide unparalleled flexibility to match your business needs. These APIs ensure Logitech continues to deliver insights that help you optimize operations, drive growth, and maximize the value of your Logitech investment.
Availability
1. Which devices support Logitech’s APIs?
CollabOS API
The CollabOS API is only available for CollabOS devices. For a complete list please check here.
Sync Cloud API
Sync Cloud API is available for all devices that are managed by the Sync Portal. This includes meeting room computers running the Sync agent.
2. Which regions support Logitech’s APIs?
Both the CollabOS API and the Sync Cloud API are available globally.
3. Are the APIs available to Customers/Partners/Resellers?
Customers
These APIs are accessible to customers with either a Sync Plus, Select or an Essential license. To configure them, log in as an administrator to your Sync tenant. Navigate to the Settings page, where you’ll find the CollabOS API tab and the Sync Cloud API tab. Both tabs provide access to the respective APIs for configuration.
Partners/Resellers
These APIs are available to Partners/Resellers. Please contact your Logitech partner team here to learn more about partner/reseller-only offerings.
Licensing
1. CollabOS API
The CollabOS API does not require special licensing. However, it must be enabled in the Local Network Access (LNA) settings. This API connects directly to individual devices through your custom application and only provides locally stored device data. For setup instructions, refer to the support page on enabling Local Network Access.
2. Sync Cloud API
The Sync Cloud API, available with a Sync Plus, Essential, or Select license, enables customers to access and analyze data from all connected devices, offering valuable insights over time to optimize performance and decision-making. Customers with a Basic license do not have access to this API.
Functionality
What functionality can I expect from the APIs?
CollabOS API
For the current functionality of CollabOS API, please refer to the support documentation in the Sync portal.
Sync Cloud API
For the current functionality of Sync Cloud API, please refer to the support documentation in the Sync portal.
Feature Roadmap
In addition to our current roadmap, we are always refining and expanding our plans based on your feedback and experiences. Please route any requests for additional feature growth through your Logitech account team or the Hub’s Wishlist function.
Security and Authentication
CollabOS API
The CollabOS API leverages a secure token exchange per session. First, a username and password are configured for the unique device’s web interface as part of the Local Network Access configuration. A token associated with these credentials is then generated and used to securely access the API. Requests that do not include a valid token will be rejected even if an entity had access to the device and API documentation.
Sync Cloud API
The Sync Cloud API leverages mTLS, an industry-standard authentication method that is widely used in secure applications today. This allows a unique certificate to be generated, shielded within the password-protected Sync admin portal, to serve as the authentication. The Sync portal can then also give a clear indication to admins of when this information was last used alongside functions to quickly revoke access if needed. This solution provides robust security used by many of the most secure organizations in the world today.
Testing and Tools
Postman
Postman is a great tool which can validate API performance. Users and developers can import the OpenAPI specification available on the API’s reference page to quickly test that the Logitech APIs are working properly in a sandbox environment. This allows developers to quickly verify whether the issue lies in Logitech cloud services or in their own custom development environment.
For more information on configuring Postman for use with Logitech APIs, please check out our quick start guide.
References