Integration with Router

Implementing Code Changes for Router Integration

Outlined below are the changes that members need to make to their implementation to use the SahamatiNet Router.

• Using Sahamati Router API endpoint https://api.sandbox.sahamati.org.in/router/v2 as base path for all the requests.

  • Do note the Router API endpoint URL mentioned above is used for Sandbox, the respective URL for each environment (UAT and Production) will be updated when we progress to next environments.

• Add the recipient ID under the new header x-request-meta with recipient-id in a JSON object which is the identifier of the receiver to whom the API call needs to be forwarded.

  • The value of the x-request-meta is Base64 string of the JSON object with recipient-id.

  • This structure helps us to easily extend the JSON object by adding the required attributes for future use cases.

x-request-meta: <Base64 of JSON object 
{"recipient-id":"<entityID of the recipient>"}>

The receiver could be any of the participant, FIU, AA or FIP.

Particulars	Comments
Host	The base path to use by the members of SahamatiNet Router.	​https://api.sandbox.sahamati.org.in/router
Headers	This will remain same as previous.	​ x-jws-signature - Authorization Token (from sender)
Additional Headers	The recipient id is a required property. It is the identifier of the receiver to whom the API call needs to be forwarded.	x-request-meta

These header changes need to be implemented for communication between FIU and AA, AA and FIP, FIP and AA, as well as FIU and AA.

API Collection:

58KB

Router API - Sandbox.postman_collection.json