Custom Responses Usage

This page explains the integration of custom entities and custom responses configured with router APIs.

Overview:

Using mock entities, developers can simulate the behavior of real entities within a controlled environment. Likewise, mock responses enable developers to define and manipulate the expected outcomes of API calls, replicating various scenarios that may arise in the workflow.

The sample workflow diagrams below illustrates the usage of the Mock Entities and Responses by including entity id and scenario id under headers.

Sample workflow of mocking success scenario

Sample workflow of mocking error scenario

The following two details are required in the request to use the APIs with custom entity and respective configured response:

• x-request-meta: This header specifies the router that will route the request to the respective custom entity created using Create API.

• x-scenario-id: This header should contain the scenario id for the specific response configured for respective entity using Add response API

Sample Request Headers:

x-request-meta: [Base64 of {"recipient-id": "<custom-aa-id>"}]
x-scenario-id: custom-aa-id-500-error