Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
titlePrevious Versions

Version

Publication Date

Notes

https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/329678849/API+Hub+Sandbox+v1.2+2025.02.26?atlOrigin=eyJpIjoiNGJkOThmNDA3NjBiNDViYzhjYmQ0OWFmMzM4YzI5MGQiLCJwIjoiYyJ9

Contains updates resulting from service desk tickets

API Hub Sandbox v1.1 2025.01.23

Contains updates resulting from service desk tickets

API Hub Sandbox v1.1 2024.12.17

Contains all API endpoints from v1.1, together with additional features and fixes

API Hub Sandbox v1.1 2024.11.19

Contains additional API endpoints, features and fixes

API Hub Sandbox v1.1 2024.09.20

Initial release. No longer supported, please do not

...

u

4. Using Postman

4.1 Introduction

...

  1. Download and install https://www.postman.com/

  2. 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 )

  3. Register your TPP client in the API Hub Sandbox, see https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/329678849/API+Hub+Sandbox+v1.1 2+2025.01.2302.26?atlOrigin=eyJpIjoiNGJkOThmNDA3NjBiNDViYzhjYmQ0OWFmMzM4YzI5MGQiLCJwIjoiYyJ9

  4. Request a Postman Environment file:

    1. 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.

  5. Import the Postman Collection and Environment File into Postman

    Screenshot 2024-11-20 at 09.51.23.png

  6. Configure the OFTF Transport Certificates in Postman

    1. Go to Settings > Certificates > Add Certificate

    2. 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)

    3. Import the Transport Certificate (CRT file) from the OFTF Sandbox, see section 2 above

    4. Import your Transport Key (KEY file) the Private Key which will have stored locally

      Add Certificate.png

  7. Set the following general Postman settings

    1. Go to Settings > General

    2. Set SSL certificate verification: OFF

    3. Set Automatically follow redirects: ON

      Postman Settings 1.png

      Postman Settings 2.png

  8. Select the required environment file, which contains the server host definitions. Make sure you use the correct (latest) environment.

    Load Environment.png

  9. Edit your environment to add the _clientId, kid_-local, and pem_-local as follows:

    1. _clientId - the Client ID of your application from the OFTF Sandbox

      View Client ID.png

      Insert the Client ID value from the OFTF Sandbox into the Postman _clientid variable of your environment

      Enter Client ID.png

    2. kid_-local - the Key Id (KID) of the OFP UAE CLIENT SIGNING certificate created for your application from the OFTF Sandbox

      View Key ID.png

      The KID is then inserted into the kid_-local field of the altaraq-sandbox environment

      Enter Key ID.png

    3. pem_-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

Code Block
"AccountId": "100004000000000000000002"
"SchemeName": "AccountNumber"
"Identification": "10000109010102"
"AccountType": "Corporate"
"Name": "Luigi International"

mits

mits

Code Block
"AccountId": "100004000000000000000003"
"SchemeName": "AccountNumber"
"Identification": "10000109010103"
"AccountType": "Retail"
"Name": "Mario International"

mits

mits

Code Block
"AccountId": "100004000000000000000005"
"SchemeName": "IBAN"
"Identification": "10000109010105"
"AccountType": "Retail"
"Name": "Spectrum"            

rora

rora

Code Block
"AccountId": "100004000000000000000001"
"SchemeName": "IBAN"
"Identification": "10000109010101"
"AccountType": "Retail"
"Name": "Mario Current"

rora

rora

Code Block
"AccountId": "100004000000000000000004"
"SchemeName": "AccountNumber"
"Identification": "10000109010104"
"AccountType": "Corporate"
"Name": "Luigi PrePaid Card"

rora

rora

Code Block
"AccountId": "100004000000000000000006"
"SchemeName": "AccountNumber"
"Identification": "10000109010106"
"AccountType": "Corporate"
"Name": "Peach Charge Card"

rora

rora

Code Block
"AccountId": "100004000000000000000007"
"SchemeName": "IBAN"
"Identification": "10000109010107"
"AccountType": "Retail"
"Name": "Bowser Other"

rora

rora

Code Block
"AccountId": "100004000000000000000008"
"SchemeName": "IBAN"
"Identification": "10000109010108"
"AccountType": "Corporate"
"Name": "Toadstool Current"

rora

rora

Code Block
AccountId": "100004000000000000000009"
"SchemeName": "AccountNumber"
"Identification": "10000109010109"
"AccountType": "Retail"
"Name": "Yoshi Savings"

rora

rora

Code Block
"AccountId": "100004000000000000000010"
"SchemeName": "IBAN"
"Identification": "10000109010110"
"AccountType": "Corporate"
"Name": "Koopa Credit Card"

rora

rora

Code Block
"AccountId": "100004000000000000000011"
"SchemeName": "IBAN"
"Identification": "10000109010111"
"AccountType": "Retail"
"Name": "Daisy PrePaid Card"

...

4.4 Downloading Environment  through  Postman

  1. Navigate to Postman Environment folder from the collection

...

  1. Then go to Get/environment endpoint

    1. Add value of client_id which you will get from Admin Portal

...

  1. Then click on the send button.

...

  1. Then Navigate to the 3 dots at the Right hand side corner

    1. Click on Save response to file

...

  1. By clicking on Save, Postman Environment will get downloaded successfully

...