Skip to content

README.md

Latest commit

 

History

History
48 lines (31 loc) · 2.52 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.52 KB

APIM Bruno Collection

This Bruno collection provides end-to-end testing capability for the API Management (APIM) integration.

Prerequisites

Before using this collection, ensure the following requirements are met:

1. Active Pull Request

Your feature branch must have an open pull request (draft or ready for review) to ensure the preview Lambda function and proxy are deployed and operational.

2. Bruno Environment Variables

The following environment variables will need to be configured in Bruno:

Variable Description Example
PRIVATE_KEY_PATH Path to your private key file on your local machine /home/user/.ssh/api-key.pem
JWT_SECRET Active API Key from your Developer Hub application your-api-key-here
PR_NUMBER The pull request number for your preview environment 123
APIM_ENV The APIM environment you're testing against internal-dev
KID The Key ID to utilise when generating an access token INT-1

3. Bruno Global Environment Variables

The following environment variables also need to be configured as global variables in Bruno:

Variable Description Example Secret
APIM_ENV The APIM environment you're testing against internal-dev
auth_token The auth token to use when accessing APIM your-auth-token-here x

4. Developer Hub Application Setup

Register an application on the Internal Developer Hub:

  1. Generate a public/private key pair
  2. Upload the public key to your application
  3. Copy the Active API Key and set it as the JWT_SECRET environment variable in Bruno

5. Configure Proxy Endpoint

The POST request URL automatically targets your preview environment proxy using the PR_NUMBER and APIM_ENV environment variables, which you will need to set. The URL follows this format:

https://{{APIM_ENV}}.api.service.nhs.uk/pathology-laboratory-reporting-pr-{{PR_NUMBER}}/FHIR/R4/Bundle