API Interaction

Asynchronous mode

Data flow in asynchronous mode:

  1. Client application makes a call to the listener API by setting isSync to false.
  2. Listener API validates the request and if any validation failure occurs, it moves the request to the fall-out queue and responds to the client with an appropriate error message.
  3. If validation succeeds, then the message is moved to automation exchange which in turn moves the request to the corresponding profile queue. Queue details are present in the message details sent by the client application.

 

Synchronous mode 

Data flow in synchronous mode:

  1. Success flow – Success queue
  2. Client application makes a call to the listener API by setting isSync to true. If validation succeeds, then the message is moved to automation exchange which in turn moves the request to the corresponding profile queue. Queue details is present in the message details sent by the client application.
  3. Robot picks up the request, processes it, and on success, moves it to success queue. Response is sent back to API which in turn sends it back to the client application. 

 

Failure flow – failure while processing the request – failure queue:

  1. Client application makes a call to the listener API by setting isSync to true.
  2. If validation succeeds, then the message is moved to automation exchange which in turn moves the request to the corresponding profile queue. Queue details is present in the message details sent by the client application.
  3. Robot picks up the request, process it, and on failure, moves it to failure queue. Response is sent back to API which in turn sends it back to the client application. In this case, the status will be set as success and the client needs to read the error detail object to know the reason for processing failure.

 

Failure flow – failure while validating the request – fallout queue:

  1. Client application makes a call to the listener API by setting isSync to true.
  2. If validation fails, then the message is moved to the fallout queue. Robot will not pick up the request for processing. Status will be set to failure and sent back to the client with appropriate message details