Notification APIs

Radial Order Management's notification APIs are asynchronous APIs that use the Advanced Message Queuing Protocol (AMQP) standard.

Notification API Architecture

The notification API architecture is centered around a RabbitMQ edge server. RabbitMQ is an open-source message broker that implements the Advanced Message Queuing Protocol (AMQP) standard.

Radial Order Management’s internal event bridge delivers events to RabbitMQ. RabbitMQ handles authentication and authorization for external clients, and delivers each client’s events to the appropriate queue.

To consume events from the notification APIs, you can use any client that implements AMQP. Existing AMQP clients support a number of programming languages, making it easy to integrate AMQP in a wide range of software settings.

For information on RabbitMQ and AMQP clients, visit http://www.rabbitmq.com/.

Set Up to Use Order Events

The setup to consume events from notification APIs includes the following stages:

Decide which events will be part of your integration. Consider the full list of events supported by the notification APIs, and decide which events you will use.
Consider whether to use a single-topic or multiple-topic approach. An AMQP topic can be thought of as a stream of related messages. A single-topic approach lets you retrieve all your messages in a single location, but you then need to do your own filtering by message type to decide on the followup action for each message. A multiple-topic approach sorts the messages for you, but requires you to monitor multiple locations. Radial can set up your message queue using either approach.
Work with Radial personnel to activate your message events. Some setup steps must be completed by Radial before your events are available on the RabbitMQ server.
Set up your AMQP client, using the store-specific topic addresses provided by Radial.
Consume and use the message XML files. Refer to the event’s schema (XSD file) and sample messages on the page for each notification API.