Each developer created application that uses Plantronics APIs to access data from Plantronics Manager Pro requires the creation of a unique appID before data access can be enabled. The appID is required for calling any of the report APIs in a production tenant. Developer apps can be installed in an unlimited number of tenants, but a unique appID must be created for each Plantronics Manager Pro tenant for which the application will be integrated with. The application authorization scheme will require both appId and tenantId.
To obtain an appID, follow this sequence of API workflow steps. This is a one time sequence for each tenant.
STEPS:
- To obtain an appID you must register the app details and the developer profile. For details about registering an app, please review the API documentation.
- Sample Curl -
curl -X PUT --header "Content-Type: application/json" -d "{ \"description\": \"This will a sample app providing conversation analysis.\", \"name\": \"ConvAnalysisApp\", \"partnerProfile\": { \"email\": \"manoj.ramakrishnan@plantronics.com\", \"firstName\": \"Manoj\", \"lastName\": \"Ramakrishnan\", \"partnerName\": \"PltPartner\" } }" "http://plantronics-prod.apigee.net/app?apikey=1hKMMPFMmaldnC0rcohvXN0UX7UeWPjb"
- Access-Control-Allow-Credentials:
- true
- Access-Control-Allow-Origin:
- http://dev-plantronics.pantheonsite.io
- Connection:
- keep-alive
- Content-Type:
- application/json;charset=UTF-8
- Date:
- Fri, 07 Jul 2017 22:09:57 GMT
- Server:
- Apache-Coyote/1.1
- Transfer-Encoding:
- chunked
- Vary:
- Origin
{
"_links": {
"self": {
"href": "https://partner-api.preview.pltzone.org/v1/partner/app/87a8c4ea-ee20-4f94-b61d-1261d06c8bfc"
}
},
"description": "This will a sample app providing conversation analysis.",
"dateCreated": 1499465397513,
"dateUpdated": 1499465397513,
"name": "ConvAnalysisApp",
"status": "ENABLED",
"tenantAppAuth": [],
"partnerProfile": {
"id": "f76621db-8eae-4c3f-83bc-3872c3445e52",
"email": "manoj.ramakrishnan@plantronics.com",
"firstName": "Manoj",
"lastName": "Ramakrishnan",
"partnerId": "e75c8290-02b6-4057-a735-760c33dc7049",
"partnerName": "PltPartner"
},
"errorMessage": null,
"id": "87a8c4ea-ee20-4f94-b61d-1261d06c8bfc",
"subscriptions": null
}
---
Next Step
- If utilizing REST data: Request and Receive App Authorization
- If utilizing streaming data: Ingesting and Consuming Streaming Data