Welcome to the CollabOS API Quick Start Guide! This guide will walk you through the steps to set up Postman for seamless API testing. With the CollabOS API, you gain powerful tools to interact directly with CollabOS devices, and Postman serves as the perfect hub to test and refine those APIs. From importing your API definitions to configuring your Postman workspace, this guide is designed to help you hit the ground running.

1. Start with downloading and installing Postman: https://www.postman.com/

2. Login to Sync Portal: navigate to the CollabOS API tab via the Settings Tab

   

3. Ensure that Local Network Access is enabled on the device to which you plan to connect.

   1. Make note of the following details for that device:
      1. IP Address/Hostname
      2. LNA Username
      3. LNA Password

4. Download the OpenAPI spec; you will be uploading this document into Postman.

   

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

   

   You will see ‘Device Management API’ in your workspace

   

6. Navigate to Variables. Configure the baseURL (https://[your device IP]).

   

7. Select Sign In. Configure the username and password under Body. ****Under Authorization, set to No Auth.

   

8. Save your work. Now test out Postman by hitting the Send button. If everything is setup correctly, you will see a ‘200’ in the body below and an authorization token.
   TAKE NOTE OF THIS AUTHORIZATION TOKEN.

   

9. In any other command sent, configure the Authorization to Bearer Token and enter the previous authorization token in the field.

   

10. Click Save and then Send on the command once the authorization token is entered. You should now see response data in the body appropriate to the endpoint used.