Hill Labs API

Two ways to connect. Choose by what your integration needs to do.

Choose the B2B API when you need your organisation's system to connect directly to Hill Labs, submit orders and work with results. Choose API Connected Apps when you are building an app that your customers connect to mylab so they can view the Hill Labs results they are authorised to see.

Choose an integration Compare the two paths
Pick your integration

Which journey fits your needs?

B2B API

Your organisation’s systems connect directly.

Choose this path to connect your organisation's software directly to the supported Client API functions.

Typical capabilities

  • You can submit orders to Hill Labs using the order endpoint.
  • You can retrieve result history, latest results and available PDF reports.
  • You can receive results through a configured push notification endpoint.
  • You can register a donor through the documented API function.
Sign-in: server-to-server API credentials and access token
Read the current B2B API documentation
API Connected Apps

Your customer connects to your approved third-party app.

Use this path to show your customer their Hill Labs results in your app. Before they can connect, Hill Labs must approve and register your app. They authorise access through mylab, Hill Labs’ customer portal.

First-release access

  • Your customer signs in to mylab and approves your named third-party app.
  • Your app retrieves that customer's results, including in batches.
  • You cannot submit orders or receive results push notifications through this path.
Sign-in: customer authorisation through Hill Labs
Read the Connected Apps documentation
How it works

Two paths, two different connection flows.

B2B API

Connect your system directly to Hill Labs.

Authenticate your organisation’s system, then use the API functions and result-delivery options that fit your workflow.

  1. 01Hill LabsConfigure your API accessHill Labs provides the configuration needed for development and testing.
  2. 02Your backendRequest an access tokenUse your OAuth 2.0 credentials, then send the token as a bearer token with API requests.
  3. 03Your backend · Hill Labs APICall the functions you needSubmit orders, register donors or call other supported Client API endpoints for your workflow.
  4. 04Hill Labs API · your systemRetrieve or receive resultsPoll result history, retrieve the latest results and available reports, or receive notifications through a configured endpoint.
API Connected Apps

Connect your customer, then retrieve their results.

Your approved app asks for access through mylab. Your backend exchanges the authorisation code and requests results for that customer.

  1. 01Your appAdd a connect actionGive your customer a clear action, such as Connect to Hill Labs, in your approved app.
  2. 02Your customer · mylabSign in and review accessYour customer signs in if needed, then approves or declines the results access your app requests.
  3. 03mylab · your backendHandle consent and exchange the codeWhen approved, mylab redirects the browser to your registered callback with a one-time authorisation code. Exchange it securely in your backend.
  4. 04Your backend · Hill Labs APIRequest authorised resultsRequest results for the customer who approved the connection. Hill Labs returns only results that customer can access through mylab.
  5. 05Your appShow results in your appUse a job reference where available. If you do not have one, use the sample name to help find the right result.
Side by side

Choose based on who signs in and what your integration needs to do.

QuestionB2B APIAPI Connected Apps
Who signs in? Your integration platform authenticates its server-side connection to the Hill Labs API. Your app starts the connection. Your customer signs in to mylab and authorises your app to access their Hill Labs results.
What can you do with this path? You can use supported Client API functions, including order submission and results access. You can read results for the customer who approved the connection.
How do you access results? You can poll history, fetch job results or reports, or receive configured result notifications. Your app requests results, including batches, when you need them.
Who are your requests for? Your onboarded organisation, using its configured API access. Your requests are tied to the mylab customer who approved the connection. Hill Labs returns only results that customer can access through mylab.

Need help choosing? Call +64 7 858 2000 or email cx@hill-labs.co.nz.