Versions Compared

Key

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

...

  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/Internal/pages/251953153/API+Hub+Sandbox+User+Guide#3.-Accessing-the-API-Hub-Sandbox)

  3. Register your TPP client in the API Hub Sandbox, see API Hub Sandbox v1.1 2024.11.19

  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.

    2. We will then respond on the ticket to send you a pre-configured 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 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

...