☰UKHSA Developer Portal and API Catalog
A one-stop shop for all our teams to share and collaborate on our internal APIs.
Getting Started
API Publishers
For API Publishers:
Onboard your APIs with the UKHSA Platform Team and follow the API Governance Process.
Group related APIs into API products based on their functionality, audience, or use case.
Provide comprehensive documentation for each API, including endpoints, request-response formats, parameters, headers, authentication methods, and usage instructions.
Include security-related information such as authentication requirements and authorization scopes.
Configure the relevant access policies for your registered APIs and API Products before publishing.
API Subscribers
Sign up using your Azure AD credentials
Sign in
Request requisite API keys or access tokens
Manage API subscriptions and access keys, view usage analytics, and renew or revoke access as needed.
Our APIs
This developer portal offers a range of APIs and API Products to be used within our UKHSA ecosystem.
Sign up and subscribe to make use of available APIs.
Find more information on available APIs, and even test API requests within the Developer Portal.
POST /api/examples
{
"id": "16833741-33a0-437c-9c82-368bed96b7f6",
"from": "562b5682-7861-49ac-ad60-074fe12ddac2",
"to": "7d334e64-d0d3-4941-be6c-f59facf781d6",
"currency": "USD",
"amount": 314.55
}
