Health Platform GroupDevelopersContact our team
Browse documentation
Get startedIntroduction

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.

ProductsServicesDirectory data
HPGConnected healthcare

Choose your integration

Start with the experience you want to create. We’ll help you find the right connection for your platform and customers.

Integration process

Agree the scope and access requirements before development begins.

  1. 01

    Tell us what you’re building

    Share your platform, audience and the healthcare services you’d like to offer.

  2. 02

    Define the connection

    Work with our team to confirm the integration model, service availability and access requirements.

  3. 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.

GET/v1/servicesExample endpoint
Example request
curl "https://api.example.com/v1/services" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"
Example 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.

Illustrative HTTP response codes
CodeMeaningWhat to check
200OKThe request completed successfully.
400Bad requestReview the request format and required fields.
401UnauthorisedCheck the authentication requirements.
429Too many requestsFollow the endpoint’s retry guidance.
Continue readingGetting startedPrepare your team, environment and launch checklist.

Browse documentation