...
The API Hub Sandbox is being continually updated to support more API sets and functionality. Please use the latest version from the list below.here: https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/329678849/API+Hub+Sandbox+v1.2+2025.02.26?atlOrigin=eyJpIjoiNGJkOThmNDA3NjBiNDViYzhjYmQ0OWFmMzM4YzI5MGQiLCJwIjoiYyJ9 , which contains updates resulting from service desk tickets and Open Product functionality.
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
...
|
4. Using Postman
4.1 Introduction
...
Download and install https://www.postman.com/
Download the Postman Collection from the latest version of the API Hub Sandbox (see https://openfinanceuae.atlassian.net/wiki/spaces/InternalOF/pages/251953153195788812/API+Hub+Sandbox+User+Guide#3.-Accessing-the-API-Hub-Sandbox )
Register your TPP client in the API Hub Sandbox, see https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/329678849/API+Hub+Sandbox+v1.1 2024.11.192+2025.02.26?atlOrigin=eyJpIjoiNGJkOThmNDA3NjBiNDViYzhjYmQ0OWFmMzM4YzI5MGQiLCJwIjoiYyJ9
Request a Postman Environment file:
Once your TPP client is successfully registered (step 3 above), please raise a ticket on the Nebras Service Desk requesting your Postman Environment file. Please include your TPP Name and Client Id when raising the ticket. We will then respond on the ticket to send you a pre-configured Postman Environment filerefer to https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/195788812/API+Hub+Sandbox+User+Guide#4.4-Downloading-Environment--through--Postman to obtain the Postman Environment file.
Import the Postman Collection and Environment File into Postman
Configure the OFTF Transport Certificates in Postman
Go to
Settings > Certificates > Add Certificate
Enter the Host URL as below (please note this example is for Al Tareq Model LFI 1, and over time we may create additional Model LFIs)
Import the Transport Certificate (CRT file) from the OFTF Sandbox, see section 2 above
Import your Transport Key (KEY file) the Private Key which will have stored locally
Set the following general Postman settings
Go to
Settings > General
Set
SSL certificate verification: OFF
Set
Automatically follow redirects: ON
Select the required environment file, which contains the server host definitions. Make sure you use the correct (latest) environment.
Edit your environment to add the
_clientId
,kid_-local
, andpem_-local
as follows:_clientId
- the Client ID of your application from the OFTF SandboxInsert the
Client ID
value from the OFTF Sandbox into the Postman_clientid
variable of your environmentkid_-local
- the Key Id (KID) of theOFP UAE CLIENT SIGNING
certificate created for your application from the OFTF SandboxThe KID is then inserted into the
kid_-local
field of the altaraq-sandbox environmentpem_-local
- the Private Key of your Signing Certificate.
This is the OFTF Signing Certificate Private Key that you created when you created the Signing Certificate CSR.
The Signing Ley needs to be represented as a single line to be included in the Postman environment.
To acheive achieve this in MacOS and Linux, the tr (translate) command can be used as follows, which removes the newline characters.Code Block tr -d '\n' < 98863a9e-ae4f-4593-a894-714cbbc91ffb-opf_uae_client_signing.key > single-line-opf_uae_client_signing.key
...
The Postman Collection contains a number of steps in order, which will walk you through each of the API flows in the API Standards.
The Authorization Flow currently supports a single two test User (users username: mits, password: mits )and username: rora, password: rora
Eight new accounts of various types, including an additional active account with a negative balance using the rora user.
Username | Password | Account details | ||
---|---|---|---|---|
mits | mits |
| ||
mits | mits |
| ||
mits | mits |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
| ||
rora | rora |
|
...
4.4 Downloading Environment through Postman
Navigate to Postman Environment folder from the collection
...
Then go to Get/environment endpoint
Add value of client_id which you will get from Admin Portal
...
Then click on the send button.
...
Then Navigate to the 3 dots at the Right hand side corner
Click on Save response to file
...
By clicking on Save, Postman Environment will get downloaded successfully
...