API Details

All the APIs mentioned below are authenticated based on TCUP api-key and app-key. These two keys are used to uniquely identify each tenant and its application. In order to access the service API, the following custom header has to be passed as request header.

Custom Request Header

  • x-api-key : a mandatory header to pass along with every API call

  • x-app-key : an optional header to pass APP key for the calling application

The following are the list of APIs available in MR service. In the following section we will describe all the following operations using API / portal.

List of API Services:

TopicExchanges

  • Create a topic exchange

  • Get list of topic exchange

  • Get topics on a topic exchange

  • Delete a topic exchange

RoutingChannel

  • Start the routing channel

  • Stop the routing channel

  • Get associated routing keys

RoutingRules

  • Create a routing MR rule

  • Get all MR routing rules

  • Get a MR routing rule by rule ID

  • Update a MR routing rule

  • Delete a MR routing rule

Statistics

  • Get aggregated statistics of rules

  • Get rules overview

  • Get statistics for a rule

Versions

  • Get all matching rules’ versions

  • Get all versions of a rule

  • Get a version of a rule

SendRequest

  • SendRequest for posting data to MR rule

Note

Before operating on any of the above APIs, the user needs to have authentication to acces API along with x-api-key which enables them to use MR service.