REST API

FioranoMQ provides a REST API which can be used to return information about the status of the FioranoMQ server at any particular instance of time. The REST services are provided by a Jersey servlet container which becomes operational when the FioranoMQ server is started.

The REST services power the new WMT Angular dashboard. Refer to the Angular Web Management Tool section to explore the dashboard.

A detailed list of all the HTTP endpoints exposed by the REST services along their descriptions are available on SwaggerUI. The SwaggerUI can be accessed using the following URL format:

http://<ipaddress>:<jettyport>/swaggerui

In the above URL format, '<ipaddress>' refers to the IP address or the hostname where the FioranoMQ server is running and '<jettyport>' refers to the port number used by the embedded Jetty server.

Example:

If the FioranoMQ server is running on IP address 192.168.1.46 and the embedded Jetty server is running on port 1780, the URL will be http://192.168.1.46:1780/swaggerui

SwaggerUI

SwaggerUI documents all the HTTP endpoints which are exposed by the REST services of FioranoMQ. All the available resource methods are categorized and put under the respective resource class to which they belong to. In order to invoke any resource method, an HTTP header called "apiKey" is necessary.

Obtaining API Key and Invoking Resource Methods

To obtain the API key, perform the following actions:

1. Scroll down to the resource class named "Security" and find the resource method named "/security/login".
2. Provide a valid username and password combination and set the existingApiKey field to null.
3. Invoke the login operation.

4. Copy the alphanumeric string which will be returned as a response to the invoked login operation if the supplied username and password combination is valid.

   

   In order to obtain a valid API key, the supplied username and password combination must be valid and must exist in the security realm of the FioranoMQ server instance that is running.

5. Paste the copied alphanumeric string in the HTTP header field named "apiKey" belonging to any resource method that needs to be invoked.

   

   The invocation of any resource method will fail if the supplied API key is determined as invalid by the FioranoMQ server.