Downstream Message Push using REST

OIPA can send customized messages to downstream systems. Downstream systems can choose a protocol (JMS/SOAP/REST) for receiving messages. Downstream system should post their application and security details to OIPA to receive messages from OIPA on occurrence of an event. These details can be posted using the REST APIs for OutboundApplications and Outbound Securities. When an 'Event' in PushNotifications is triggered, OIPA will look into the database for downstream application and security details to push messages to the given downstream system.

Below details are required to receive messages from OIPA using REST protocol:

Downstream Message Push with REST supports asynchronous REST calls. Downstream details required to communicate using REST protocol: "applicationUri": "APPLICATION URL" "contentType":"application/JSON" or "application/XML"

Required security details for authentication:token. For REST token should be in the format: "Base64 encoded(UserName:password)" or Base64 encoded(ClientId:ClientSecret)

Note:

Push Notifications will construct messages in XML. If the content type is selected as application/JSON then the message will be converted to JSON while pushing it downstream. If content type is selected as application/XML OIPA will send a message in XML format to the downstream. For information on API's refer OutboundApplications API.

Security

Security in REST uses basic aunthentication based on Username and Password and bearer authentication. The username and password are encrypted using Base 64 encoding whereas bearer authentication security type uses ClientID and ClientSecrets.

The downstream application will post security details to the OIPA database for messages created by OIPA. These messages will be pushed to the downstream application where they will be decrypted by the application.

Note:

OIPA does not handle encryption and decryption of messages.