1. Introduction

The API Hub Sandbox contains one or more ‘Model LFIs’, where each Model LFI has:

1. A fully functioning set of API resources (e.g. Authorization Server, Resource Server, etc) aligned to the published https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/6258951 which will behave exactly the same as an LFI’s production APIs in the API Hub.

2. Synthetic sample data for a number of fictitious Users (e.g. user names and passwords, accounts, transactions, etc).

This API Hub Sandbox therefore acts as a testing environment for TPPs, so that they can a) test their applications prior to being licensed and/or without accessing any real customer accounts and b) demonstrate their conformance to the Open Finance Standards as set out in the https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/124583943.

The API Hub Sandbox also acts as a reference implementation for LFIs so that they can compare their own API integration with the API Hub, thereby speeding up such integration activity.

2. Pre-Requisites

Developers must firstly make themselves familiar with all aspects of the https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/6258951.

In order to access the API Hub Sandbox, the LFI or TPP must nominate and onboard a Primary Business (PBC) and Primary Technical (PTC) contacts to the Open Finance Trust Framework (OFTF) Sandbox. Once onboarded, this allows the PTC to create the following artefacts within the OFTF Sandbox in order to simulate a TPP application:

1. Application

2. Application Transport Key & Certificate

3. Application Signing Key & Certificate

Detailed information about how to create the Application and Certificates is covered in the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv4/pages/183468280/Trust+Framework+User+Documentation#5.-TPPs-Quick-Access-Guide

3. Accessing the API Hub Sandbox

The API Hub Sandbox is typically accessed by a TPP using their own client application.

The API Hub Sandbox is being continually updated to support more API sets and functionality. Please use the latest version here: https://openfinanceuae.atlassian.net/wiki/spaces/OF/pages/997556225 , which contains updates resulting from service desk tickets and Open Product functionality.

4. Using Postman

4.1 Introduction

The API Hub Sandbox does not in itself have a GUI. While developers can connect their own TPP applications directly to the API Hub Sandbox (because it behaves exactly the same as an LFI’s production endpoints in the API Hub), the starting point is to use Postman to connect and test out all of the APIs.

4.2 Setting up Postman

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/OF/pages/195788812/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/820772865.

4. Request a Postman Environment file:

   1. Once your TPP client is successfully registered (step 3 above), please refer 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
   

   Open

   

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

      Open

      

7. Set the following general Postman settings

   1. Go to Settings > General

   2. Set SSL certificate verification: OFF

   3. Set Automatically follow redirects: ON

      Open

      

       

      Open

      

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

   Open

   

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

      Open

      

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

      Open

      

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

      Open

      

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

      Open

      

   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 achieve this in MacOS and Linux, the tr (translate) command can be used as follows, which removes the newline characters.

      tr -d '\n' < 98863a9e-ae4f-4593-a894-714cbbc91ffb-opf_uae_client_signing.key > single-line-opf_uae_client_signing.key

Open

4.3 Using the Postman Collection

Once your Postman Environment has been updated, you’re ready to run the Postman Collection against the API Hub Sandbox.

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 supports the following test users:

Banking API version 1.2: username: mits / password: mits
Banking API version 2.0: username: mario@biz.bix / password: PIX
Banking API version 2.1: username: omar.farsi@testmail.ae / password: PIX
Insurance: username: mits / password: mits

4.4 Downloading Environment  through  Postman

1. Navigate to Postman Environment folder from the collection

2. Then go to Get/environment endpoint

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

3. Then click on the send button.

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

   1. Click on Save response to file

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