Getting Started with Event API

The Event API service is used by client applications to add events to a first-in, first out execution queue.

In this architecture, the REST- based API service is used to expose "Event API" methods to external applications. The Windows service named "Intelligence Event API Service" is used to host the REST-based API service.

The following architecture diagram explains how Event APIs are exposed to the external application.

Prerequisites

The following prerequisites are required to work successfully with the Event API.

1. Install the BI Gateway application.

2. BI Gateway Server is installed and configured.

3. Configure the Event Interface Service with Port number. The default value is 9000. You can

   1. Authorize the Runtime account to use Event API (will be added to the aaIntelligenceEventAPIUsers group)

   2. Update the port number.

4. The Intelligence Event API service is running

5. User who is a member of the aaIntelligenceEventAPIUsers group can access the Event API methods.