1.9 Getting Started - Sync Cloud API + Postman

Welcome to the Sync Cloud API Quick Start Guide! This guide will walk you through the steps to set up Postman, an optional tool for seamless API testing. With Sync Cloud APIs, you gain powerful tools to manage and synchronize data across platforms effortlessly, and Postman serves as the perfect hub to test and refine those APIs. As a free and intuitive tool embraced by developers worldwide, Postman streamlines your testing and boosts productivity. From importing your API certifications, to configuring your Postman workspace, this guide is designed to help you hit the ground running.

Start with downloading and installing Postman: Postman API PlatformPostman: The World's Leading API Platform | Sign Up for Free.

You should see certificates available use. If you don’t, you’ll need to create one.

Once you’ve selected ‘Generate new certificate’, Sync will create both the certificate and the private key. You’ll need to download and install both into Postman.

Download the OpenAPI spec; you will be uploading this document into Postman. Also, copy your ‘orgId’ as you will need this for Postman.

Copy the API server URL. You will add this when you add certificates.

NOTE: Please ensure that your API server is api.sync.logitech.com/v1 by checking your Sync Cloud API entries in the Sync portal. For those on other regional tenants, this value may not be the same.

Go to Postman and select the Settings gear; then select Settings in the drop down menu.

Select Certificates from the left navigation panel.

Select add certificate. Here is where you will add both the certificate and private key. Select CRT file for the certificate; select KEY file for the private key file.

Add the API server information on this same screen. Then select ‘Add’. Make sure you’ve confirmed your URL is correct.

You will see HOST, CRT file and KEY file populated with your information.

Now you will add the Logitech Open API specification. Find the downloaded document and simply drop it into Postman. Select ‘Import’ to import the file.

You will see ‘Sync Cloud API’ in your workspace.

Select the GET tab to view the corresponding screen. Then, uncheck the ‘continuation’ and ‘limit’ boxes under Params. While these options may be useful during development, they are not required for this test. Next, add your OrgID to the Value box under Path Variables. The box will already contain pre-populated information—simply delete the existing data and replace it with your OrgID.

Save your work. Now test out Postman by hitting the Send button. If everything is setup correctly, you will see a ‘200 OK’ in the body below.

You’re now ready to test your API work with Postman!