Quickstart
We have carefully designed Vital’s API to ensure a seamless and hassle-free experience for developers. You can get up and running with just a few lines of code. In this guide, we will walk you through the essential steps to order your first lab test.
What you need
- If you haven’t done so yet, you can get API keys by signing up for a Vital account in the Dashboard. Detailed instructions are available here.
- One of our client libraries. The lab testing API is available for the python and node SDKs. If none of those fit your use-case, you can always directly call the API. Email support@tryvital.io for specific library support.
In the following, replace {{BASE_URL}} with your team’s environment URL.
(1) Creating a user
In the context of our API, a user refers to the patient who will be undergoing the lab test. All you need to provide is a string identifying the user on your side (client_user_id). The response to this call returns the userId on our side, which you’ll be able to use for future requests.
You can find more details in our API quickstart guide.
(2) Listing Available Tests
To retrieve the set of lab tests you have access to, use the /v3/lab_tests API endpoint. In Sandbox, you will already have access to a default set of tests. Once you’re ready to head to production, we can setup a call and get you ready for launch!
This will return a list of all the available tests to you. They include a description, turnaround time and price:
{
"lab_tests": [
{
"id": "e2eaa385-a311-4f17-b33f-2165e3d24dd9"
"name": "Lipids Panel",
"description": "Cholesterol tests",
"sample_type": "dried blood spot",
"method": "testkit",
"price": 10.0,
"is_active": True,
"lab": {
"slug": "USSL",
"name": "US Specialty Lab",
"first_line_address": "123 Main St",
"city": "New York",
"zipcode": "10001",
},
"markers": [
{
"name": "Thyroid Stimulating Hormone",
"slug": "tsh",
"description": "",
"min_value": 100,
"max_value": 200,
"unit": "fg/L"
}
],
}
]
}
You can then use the test id when creating an order.
(3) Placing an order
Ordering a test for your user is as simple as making an API call:
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"),
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"patient_details": {"dob": "2020-01-01", "gender": "male"},
"patient_address": {
"receiver_name": "John Doe",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"city": "San Francisco",
"state": "CA",
"zip": "91189",
"country": "United States",
"phone_number": "+1123456789",
},
"details": {
"type": "testkit",
"data": {
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"shipment": {
"id": "d55210cc-3d9f-4115-8262-5013f700c7be",
"outbound_tracking_number": "<outbound_tracking_number>",
"outbound_tracking_url": "<outbound_tracking_url>",
"inbound_tracking_number": "<inbound_tracking_number>",
"inbound_tracking_url": "<inbound_tracking_url>",
"outbound_courier": "usps",
"inbound_courier": "usps",
"notes": "<notes>",
"created_at": "2020-01-01T00:00:00.000Z",
"updated_at": "2020-01-01T00:00:00.000Z",
},
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
},
},
"diagnostic_lab_test": {
"name": "Lipids Panel",
"description": "Cholesterol test",
"method": "testkit",
},
"sample_id": "123456789",
"notes": "This is a note",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"status": "collecting_sample",
"events": [
{
"id": 1,
"created_at": "2022-01-01T00:00:00Z",
"status": "received.testkit.ordered",
}
],
}
As demonstrated in this Quickstart Guide, integrating with our API is straightforward, allowing you to access a wide range of lab tests with minimal effort. Placing an order for a lab test is as simple as making a request to the appropriate endpoint. With our user-friendly design and clear documentation, you can harness the power of our clinical test API to enhance your application and deliver a seamless experience to your users.