API Migration Notice

🚧

Important

v0.0.1 = v1beta

Our Developer Portal enforces Semantic Versioning when it comes to versioning our documentation. You will see v0.0.1 in all the URLs and deprecation notices. This equates to our v1beta APIs that are being deprecated.

The documentation v0.0.1 version equates to the API v1beta version. Both of which are being deprecated.

Targeted Audience

Existing Avaya Experience Platform customers who are leveraging the product APIs to integrate their applications with it.

Why are you getting this notice?

Avaya Experience Platform APIs are going general availability, providing a more secure and standardized interface. As part of this change, a new API Gateway is added, and it is requiring customers to take action and modify the way the APIs are being consumed.

What are the changes?

Avaya Experience Platform APIs are getting more secured, being metered, and monitored using a new introduced API GW. As part of this transition, the following changes took place:

New API base URL:

Old - https://HOST-REGION.cc.avayacloud.com
New- https://HOST-REGION.api.avayacloud.com

New API version:

Old - https://eu.cc.avayacloud.com/api/BASE-PATH/v1beta
New- https://eu.api.avayacloud.com/api/BASE-PATH/v1

New application key:

A new authorization header key/value Application Key is now required to be added to all requests.
Usage: `appkey: [APPLICATION_KEY]'

Example that includes all changes:

For example, calling the Get Group API would now change

From

• curl --request GET --url https://{host-region}.cc.avayacloud.com/api/admin/group/v1beta/accounts/accountId/group/groupId --header 'accept: application/json' --header 'authorization: Bearer {token}’

To

• curl --request GET --url https://{host-region}.api.avayacloud.com/api/admin/group/v1/accounts/accountId/group/groupId --header 'accept: application/json' --header 'authorization: Bearer {token}' --header ‘appkey:{your-generated-application-key}’

Async Queue Metrics APIs are deprecated and replaced with Sync Queue Metrics

Please note that the Async Queue Metrices are now deprecated on the new AXP API GW and replaced with the Queue Sync Metrics. While updating your application to integrate with the new AXP API GW please ensure to use the Sync Queue Metrics described on the developer portal.

What actions should I take?

Now that the Avaya Experience Platform APIs are generally available, existing customer are expected to start transitioning using the APIs using the new and more secured method. This document contain a suggested plan on how to do the transition.

When should I start taking action?

Customer using APIs should start taking action immediately based on the outlined suggested plan.

What will happen if I fail to take action?

The old method of consuming Avaya Experience Platform APIs will be blocked July 1st 2024 and APIs calls using the old method will be blocked and failing.

Where can I get support if required?

Avaya Experience Platform APIs developers community forum, can be found on the Avaya Developer Portal under https://developers.avayacloud.com/onecloud-ccaas/discuss

If you require a professional support or advisory services to assist with the planning and executing the transition, please contact Avaya Customer Experience Services

The suggested transition plan:

The following are the suggested phases of your transition plan targeting to be ready with using Avaya Experience Platform APIs using the new method by July 1st 2024:

Phase 1: Explore the changes and the available APIs – visit https://developers.avayacloud.com/ to learn more on the available APIs and the way to consume these APIs. In addition, visit https://www.avaya-learning.com/ where you can learn more on Avaya Experience Platform APIs using course 61510W - Using Avaya Experience Platform™ APIs and Developer tools.

Phase 2: Get the additional application key – visit https://onecare.avaya.com/ where under the option of Avaya cloud solutions support, you will find the Avaya Experience Platform. Chose Request Technical Support (Incident) or Request a Service Change (MACD) and open a ticket to request the application key.

Phase 3: Analyze the changes required on your application to consume the Avaya Experience Platform APIs over the API GW

Phase 4: Build and execute a plan to modify your application – during this phase while using the existing application on

Phase 5: Test your modified application using Avaya Experience Platform APIs over the API GW.

Phase 6: Plan the transition from existing application to the modified application – include notification to customers/employees if needed as well the right timing to minimize service disruption.

Phase 7: Push your updated application to production and test its functionality.