Messaging using the REST API

Messaging using the REST API

We can use the messaging REST API to send and receive IBM MQ messages. Information is currently sent to, and received from, the messaging REST API in plain text format.

Before you begin
Note:
The messaging REST API is enabled by default. We can manually disable the messaging REST API to prevent all messaging. For more information about enabling or disabling the messaging REST API, see Configuring the messaging REST API.

The messaging REST API is integrated with IBM MQ security. The caller must be authenticated to the mqweb server and must be a member of the MQWebUser role. The caller must also be authorized to access the specified queue. For more information about security for the REST API, see IBM MQ Console and REST API security.

Get started with the messaging REST API
Before we can start the messaging REST API you must install the correct components, enable the REST API, configure security, and start the mqweb server.
Use the messaging REST API
When we use the messaging REST API, you invoke HTTP methods on URLs to send and receive IBM MQ messages. The HTTP method, for example POST, represents the type of action to be performed on the object that is represented by the URL. Further information about the action might be encoded in query parameters. Information about the result of performing the action might be returned as the body of the HTTP response.
Messaging REST API limitations
Before we use the messaging REST API, consider the following limitations:
REST API error handling
The REST API reports errors by returning an appropriate HTTP response code, for example 404 (Not Found), and a JSON response.
REST API discovery
Documentation for the REST API is available within the IBM Knowledge Center and in Swagger format. Swagger is a commonly used approach for documenting REST APIs. The Swagger documentation for the REST API can be viewed by enabling the API discovery feature.
REST API national language support
The REST API supports, with certain qualifications, the ability to specify national languages as part of an HTTP request.
Parent topic: Developing REST applications with IBM MQ

Related information

Messaging REST API reference