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.
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:
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.
Figure 1: SwaggerUI
Obtaining API Key and Invoking Resource Methods
To obtain the API key, perform the following actions:
- Scroll down to the resource class named "Security" and find the resource method named "/security/login".
- Provide a valid username and password combination and set the existingApiKey field to null.
- Invoke the login operation.
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.
Paste the copied alphanumeric string in the HTTP header field named "apiKey" belonging to any resource method which needs to be invoked.