Interfaces

DevConnect supports application development using the Avaya Analytics interfaces below.

IMPORTANT The Real-time Open Interface API using Kafka is now deprecated and new customers should use the Avaya Analytics REST and WebSocket Open Interface. The last update to the Kafka Open Interface API was release 4.1, which is compatible with Avaya Analytics release 4.1.1. Kafka-based Real Time Open Interface will not be supported for new deployments of Avaya Oceana Solution as of 13 April 2021. It remains available on Avaya Analytics 4.1.1 for existing customers only. Existing integrations that leverage the Kafka-based Real Time Open Interface will continue to be supported for 18 months from the Avaya Analytics 4.1.1 GA date of 13 April 2021. There will be no more feature development on the Kafka-based Real Time Open Interface.

Avaya Analytics REST & WebSocket Open Interface API

The Avaya Analytics REST and WebSocket Open Interface API enables real-time data retrieval from Avaya Analytics for Oceana solution. It works with the Avaya Analytics Streams Event Processors to produce real-time measures that are published to authenticated subscribers via the REST and WebSocket interfaces.The REST interface handles administration and subscription requests, while the WebSocket is purely used as a transport mechanism for real-time data. The Event Processor applications produce measure data at a dimensional level and send updated real-time measure values to Kafka topics, which are filtered by the Data Publisher and then forwarded to WebSocket endpoints.

For detailed information about the Avaya Analytics API, see the Avaya Analytics REST & WebSocket Open Interface API Guide available under Releases for the release of Avaya Analytics you are using.

Avaya Analytics for Oceana Real-time Open Interface API (Kafka-based)

The Avaya Analytics open interface API exposes real time data from Avaya Analytics for Oceana solution. It consists of a number of core components including an event processor, real-time data store and presentation layer, historical data store and presentation layer.

For detailed information about the Avaya Analytics API, see the Avaya Analytics for Oceana Real-time Open Interface API Guide available under Releases for the release of Avaya Analytics you are using. Note: The last update for this API was release 4.1.

Loading...