Build with Health Platform Group
Developer documentation
Use these guides to plan a referral, embedded experience or API integration with Health Platform Group. Confirm service availability and technical requirements with our team before implementation.
Choose your integration
Start with the experience you want to create. We’ll help you find the right connection for your platform and customers.
Referral links
Introduce your audience to a healthcare service through a referral journey.
Explore referralsEmbedded experiences
Discuss co-branded or embedded journeys that feel at home in your product.
Explore embeddedAPI integrations
Explore how an API connection could fit your own interface and workflows.
Explore the referenceIntegration process
Agree the scope and access requirements before development begins.
- 01
Tell us what you’re building
Share your platform, audience and the healthcare services you’d like to offer.
- 02
Define the connection
Work with our team to confirm the integration model, service availability and access requirements.
- 03
Build, test and launch
Once your scope is agreed, we’ll provide the relevant technical details and next steps.
Explore request patterns in your preferred language. Examples use api.example.com; use the base URL and credentials supplied for your integration.
/v1/servicesExample endpointcurl "https://api.example.com/v1/services" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"const response = await fetch("https://api.example.com/v1/services", {
headers: {
Authorization: `Bearer ${process.env.HPG_API_KEY}`,
Accept: "application/json",
},
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status}`);
}
const services = await response.json();import os
import requests
response = requests.get(
"https://api.example.com/v1/services",
headers={"Authorization": f"Bearer {os.environ['HPG_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
services = response.json(){
"data": [
{
"id": "service_example",
"name": "Example healthcare service",
"type": "consultation"
}
]
}Server-side credentials
Store integration credentials in server-side environment variables. Keep them out of browser code, public repositories and shared screenshots.
HTTP response codes
Use the response status to understand what happened and what to do next. See the API reference for request handling patterns.
| Code | Meaning | What to check |
|---|---|---|
200 | OK | The request completed successfully. |
400 | Bad request | Review the request format and required fields. |
401 | Unauthorised | Check the authentication requirements. |
429 | Too many requests | Follow the endpoint’s retry guidance. |