Developer tenant getting started POSTman collection

mramakrishnan — Mon, 10 Sep 2018 16:27:38 +0000

Keywords:

DevTenant

Now that you have been issued a developer tenant for getting started with Plantronics Manager Pro Open APIs, we want to help you get started, using sample API calls into our QA tenant as a point of reference. We have created a POST collection to help you get started with a pre-tested working set of POSTman collections. Download this zip file to get started:

https://developer.plantronics.com/files/oda-stagingpostmancollectionzip

Data Access Suites

The collection is divided into multiple suites such as:
Asset Management and Adoption Suite

Manage your Plantronics audio device deployment with Asset Management and Adoption. Capture detailed inventory information, check softphone and firmware versions and detect potential conflicts before they happen.

Device Adoption: Examine the adoption patterns of Plantronics products across your organization.
Device Distribution: View the distribution of devices among users, including Plantronics and other supported manufacturers’ devices, and identify users without a detected device.
Device Inventory: View the total count and status of all headsets in your organization.
Incompatible Products: Identify configurations of devices, softphones and Plantronics Hub versions with known compatibility conflicts.
Policy Compliance: Monitor users’ compliance with the hardware and software policies you have defined.
Softphone Adoption: Examine the adoption patterns of softphones across your organization.
User Activity: Understand users’ headset activity patterns, including headset calls made or received, and call duration.
Version Status: View the distribution of Plantronics firmware and software versions across your enterprise.

Call Quality and Analytics Suite

Improve the quality of conversations and increase the adoption of voice applications by capturing details such as the percentage of speaking time on each side of the call, and the amount of silence and over-talk. You will also be able to quickly troubleshoot audio issues related to the radio link.

Common Actions: Identify user behavior patterns related to mute, volume and Quick Disconnect functionality that may hold insights for training purposes and assessing agent performance.
Conversation Details: Improve the quality of conversations by identifying individuals and/or physical locations where the percentage time of over-talk during conversations is higher than normal.
Radio Link Quality: Analyze and troubleshoot radio link quality with Bluetooth headset to USB adapter connection metrics

Health and Safety Suite

Ensure employee safety and compliance with regulations using data provided by acoustic incidents to capture insight into the history of the acoustic environment, including the number of mitigated acoustic events and daily noise exposure averages.

Acoustic Events: Review the history of acoustic events that occurred during conversations using Plantronics devices.
Noise Exposure: Identify time-weighted average (TWA) configurations that may be causing user experience issues.

Foundational

This collection provides related insigts of a tenant such as softphone usage, productsById etc.

WebSockets-Real Time

Start Stream: Stream Types are different events that Plantronics Open Data Access supports as notifications- Link Quality events at the end of a call is an example. This request will start the notifications with the requested protocol.
Stop Stream: Stream Types are different events that Plantronics Open Data Access supports as notifications- Link Quality events at the end of a call is an example. This request will start the notifications with the requested protocol.

Please download the files and unzip them. You will find a collection file json and an environment json file.

Follow the below steps after downloading the json files.

1. Open Postman application and click on Import button on the top.
2. Select ODA API-Staging.postman_collection.json file and import it to Postman.

Below image shows postman after importing the collection:

Capture.JPG

3. Click on the settings icon on the right corner of the postman application
4. Click import button on Manage Environments window
5. Import Staging.postman_environment json file.

Below images shows the steps to import environment json file.

Capture.JPG

Postman should look like the below image after importing the collection and environment json files.

Capture.JPG

**Red circle indicates: collection; Blue circle indicates: environment variables

In order to change the environment variables such as tenantId, appId etc, follow the below steps:
1. Click on the settings button from the right corner.
2. Select the environment. For ex: Staging

Capture.JPG

Enter the values as shown in the below image:

Capture.JPG

tenantApiCode could be found from PM Pro:
1. Login to PM Pro
2. Click on Account tab from Admin section
3. Click on company profile.

Plantronics Developer Connection - DevTenant

Developer tenant getting started POSTman collection

Capture.JPG

Capture.JPG

Capture.JPG

Capture.JPG

Capture.JPG

Capture.JPG