Get started with the Java SDK

Add the Ovok Java SDK, connect to the sandbox, sign in, and make a first request.

Install

The SDK needs Java 17 or later. With Gradle:

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.ovok:ovok-sdk:0.1.0")
}

Create a client

import com.ovok.sdk.Ovok;
import com.ovok.sdk.OvokConfig;

Ovok ovok = new Ovok(OvokConfig.builder()
        .baseUrl("https://api.sandbox.ovok.com")
        .tenantCode("your-tenant")
        .build());

Sign in

import com.ovok.sdk.LoginCredentials;
import com.ovok.sdk.LoginResult;
import com.ovok.sdk.ProfileType;

LoginResult result = ovok.auth().login(new LoginCredentials(
        ProfileType.PRACTITIONER, "person@example.com", password));

if (result.status().equals("mfa-required")) {
    result = ovok.auth().verifyMfa(result.challenge(), mfaCode);
}

A backend service can use client credentials instead; see machine clients.

Make a first request

import tools.jackson.databind.JsonNode;

JsonNode patient = ovok.fhir().read("Patient", "patient-id");

Next: full Java SDK docs.

Last updated on

On this page