Purpose
This document outlines the overall onboarding process required to integrate with and utilise the Hill Labs API. It is intended for Hill Labs’ customers only. It describes what you need to do, what technical skill sets will be required and what process we will go through in order to help you establish API connectivity.
We’ve all used APIs before in which loose documentation is handed over and developers progress via trial and error. This can be time consuming, expensive and doesn’t deliver the full potential of the solution. We aim to provide enough documentation so that you can progress, but we also want to be available to help should you have any queries. This document will outline the process, timeline and support points.
Technical Requirements
The API is based on a number of secured REST endpoints. Your development team will need to have the understanding or capability to:
- Construct JSON documents to submit and request data.
- Understand authentication using JWT tokens.
- Understand REST, in particular POST and GET requests.
- Be able to construct an endpoint that will accept a pre-arranged data payload.
REST endpoints are ubiquitous and provide a universal data transfer mechanism. Therefore we are not restricted to a single development language. As long as your language of choice supports REST over HTTPS, then you will be able to interface with the API.
Limitations
Our API may not meet all your needs at present. We are working on the limitations below. If any affect you, please get in touch with the team.
| Limitation | What this means |
|---|---|
| Orders charged to another organisation | We only accept orders where your organisation will pay the invoice. We do not support your organisation submitting an order and expecting another person or organisation to pay the invoice. |
| Mapping to your custom codes | You must use our test and analyte codes. We do not support submitting data using your organisation’s codes that require translation to our codes. |
Get support
Contact the Hill Labs support team at cx@hill-labs.co.nz to discuss onboarding, configuration or questions about the API.