1.8 Getting Started - Enterprise API Quick Start Guide

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 use Postman to interact with the Logitech Sync Cloud API and CollabOS API—making it easy to test, explore, and streamline your automation efforts.

Prerequisites

1. Postman Installed: Ensure Postman is installed on your machine. Download the latest version from Postman’s website.

2. 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.

3. (opt) Licensed Rooms: The Sync Cloud API will only return information about spaces with Plus, Essentials or Select Licensing (or an active Select trial).

Using Sync Cloud via Postman

Generate your connection details in Sync

1. Log into Sync.

2. Navigate to Settings in the left nav bar.

3. Open the Sync Cloud API Tab.

4. In the top section, select Generate new certificate.

5. Record your certificate (certificate.pem) and private key (privateKey.pem) details.

   1. Only two certificates are supported at the same time within one sync account.

   2. Certificate best practices.

      1. Never store your private key in plain text, in a code repository, or in code.

      2. Deactivate or delete certificates when no longer needed.

      3. Rotate certificates regularly.

   3. 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.

6. Scroll down past the Sync API client certificates panel.

7. Record your Org ID; you will need this later.

8. Select API Servers beneath this.

9. Record your API Server (you may have only one option).

Configuring Certificates in Postman for the Sync Cloud API

1. Launch Postman.

2. Click on the gear icon in the top-right corner and select Settings.

3. Navigate to the Certificates tab.

4. Click Add Certificate.

5. Enter the following details:

   1. Host: The API Server from above (e.g. https://api.sync.logitech.com/v1/).

   2. Port: The port number (e.g. 443 for HTTPS).

   3. Certificate and Key Files:

      1. Upload the certificate file (e.g. certificate.pem).

      2. Upload the private key file (e.g. privateKey.pem).

6. Click Save.

Setting up your collection

1. Import the OpenAPI Spec:

   1. Download the OpenAPI Spec from the Sync Portal under the Sync Cloud API tab.

   2. Click Import in the upper left of the Postman window.

   3. Select your downloaded OpenAPI spec.

2. Configure the Collection:

   1. Verify in collection variables that your API Server is configured correctly.

   2. Navigate to the GET /places endpoint and open variables.

   3. Add your Org ID to the path variable setting.

3. Set Up a Request:

   1. Select the /places endpoint under the Sync Cloud API Collection.

   2. Navigate to the Authorization tab and ensure that No Auth is selected. The certificate file configured will supply the authorization.

4. Send the Request:

   1. Click Send to make the API call.

   2. Postman will automatically attach the mTLS client certificate when connecting to the server.

   3. Verify the response. A successful response indicates the mTLS connection is established. You should see data about your org come back in the bottom response window.

Using the CollabOS API via Postman

Configure your device for Local Network Access

Before using the CollabOS API, Local Network Access must be enabled on the device targeted. Follow these instructions to enable this functionality.

Setting up your collection

1. Import the OpenAPI Spec:

   1. Download the OpenAPI Spec from the Sync Portal under the CollabOS API tab.

   2. Click Import in the upper left of the Postman window.

   3. Select your downloaded OpenAPI spec.

2. Set up Authorization:

   1. Within the Device Management API collection, select the Variables tab

      1. Update the baseURL field to the IPv4 address of the target device.

   2. Next, navigate to the api/v1 folder and select Sign In.

      1. Edit the Body to include the Username and Password configured for LNA on the target device.

   3. Click Send in the upper right when Sign In is selected.

3. Retrieve the authorization token:

   1. The response to this command will include a body like this.

{

"code": 200,

"message": "",

"result": {

"auth_token": "eyJhbGci ... olnoCT8d9fQxbEAPjA"

}

}

Copy this authorization token to your clipboard

4. Add the authorization token.

5. Send the Request:

   1. Click Send to make the API call.

   2. Postman will automatically attach the mTLS client certificate when connecting to the server.

6. Verify the response. A successful response indicates the mTLS connection is established. You should see data about your org come back in the bottom response window.

Troubleshooting

Certificate Errors

• Ensure the client certificate matches the private key.

• Check that the certificate has not expired.

Connection Errors

• Verify that the server’s CA certificate is trusted by Postman.

• Ensure the correct hostname and port are configured in the Postman Certificate settings.

  Debugging

• Use Postman’s Console (View > Show Postman Console) to check logs and debug the request.