Introduction
Logitech APIs provide a powerful way to manage and monitor video conferencing devices at scale. Whether you’re looking to retrieve status reports or integrate Sync capabilities into your own workflows, these APIs offer flexibility and control. In this guide, we’ll walk you through how you could usePostman to interact with the Logitech Sync Cloud API and CollabOS API—making it easy to test, explore, and streamline your automation efforts.
Prerequisites
- Postman Installed: Ensure Postman is installed on your machine. Download the latest version from Postman’s website.
- Access to Sync: You will need access to the Sync Cloud API tab or CollabOS API tab in Settings within your Sync Portal to gather the required information.
- (opt) Licensed Rooms: The Sync Cloud API will only return information about spaces with Sync Plus, Essentials or Select Licensing (or an active Select trial).
Using the Sync Cloud API via Postman
Generate your connection details in Sync
- Log into Sync
- Navigate to Settings in the left nav bar
- Open the Sync Cloud API Tab
- In the top section, select Generate new certificate
- Record your certificate (certificate.pem) and private key (privateKey.pem) details
- Only two certificates are supported at the same time within one sync account
- Certificate best practices
- Never store your private key in plain text, in a code repository, or in code
- Deactivate or delete certificates when no longer needed
- Rotate certificates regularly
- NOTE: If your solution requires a single certificate file, it’s possible to combine them into a single .pfx file. Postman does not require this and combining the certificates downloaded from the Sync portal is outside of Logitech’s support.
- Scroll down past the Sync API client certificates panel
- Record your Org ID; you will need this later.
- Select API Servers beneath this
- Record your API Server (you may have only one option)
Configuring Certificates in Postman for the Sync Cloud API
- Launch Postman.
- Click on the gear icon in the top-right corner and select Settings.