Vital Java Library

The Vital Java library provides access to the Vital API from applications written in Java.

Documentation

API reference documentation is available here.

Installation

Add this dependency to your project's build file:

Gradle

Add the dependency in your build.gradle:

dependencies {
    implementation 'io.tryvital:vital-java:0.x.x'
}

Maven

Add the dependency in your pom.xml:

<dependency>
    <groupId>io.tryvital</groupId>
    <artifactId>vital-java</artifactId>
    <version>0.x.x</version>
</dependency>

Usage

import com.vital.api.Vital;

Vital vital = Vital.builder()
  .apiKey("YOUR_API_KEY")
  .build()

var labTest = vital.labTests().get('order-id')

print(labTest)

Handling Errors

All exceptions thrown by the SDK will sublcass ApiError.

import com.vital.api.core.ApiError;

try {
    vital.labTests().get('order-id')
} catch (ApiError e) {
    e.getStatusCode();
    e.getBody();
}

Environments

When you sign up to Vital you get access to two environments, Sandbox and Production.

Environment URLs
production	api.tryvital.io
production-eu	api.eu.tryvital.io
sandbox	api.sandbox.tryvital.io
sandbox-eu	api.sandbox.eu.tryvital.io

By default, the SDK uses the production environment. See the snippet below for an example on how ot change the environment.

import com.vital.api.Vital;
import com.vital.api.core.Environment;

Vital vital = Vital.builder()
  .apiKey("YOUR_API_KEY")
  .environment(Environment.SANDBOX)
  .build()

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your build.gradle file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!