# Get started

Canonical page: https://docs.ovok.com/web-sdk/core/getting-started

**Complexity:** 1 of 5 · **Client:** Web and Node.js (`@ovok/core`) · **Time:** about 5 minutes

## Install the package [Client-side] [#install-the-package-client-side]

You need an Ovok project and its tenant code. Add the SDK to your application:

```bash
npm install @ovok/core
```

The package root exports the `Ovok` client and its types. React components and hooks come from the separate `@ovok/core/react` entry.

## Create a client [Client-side] [#create-a-client-client-side]

Create one client and reuse it for every request.

- `baseUrl` is the Ovok API origin.
- `tenantCode` selects the tenant for session storage and requests.

```ts title="ovok.ts"
import { Ovok } from '@ovok/core';

export const ovok = new Ovok({
  baseUrl: 'https://api.sandbox.ovok.com',
  tenantCode: '{{TENANT_CODE}}',
});
```

[Client configuration](./client-configuration.mdx) lists the optional settings.

## Check the connection [Client-side] [#check-the-connection-client-side]

Ask the Ovok API for its health. The response includes an `ok` flag and the status of each dependency.

```ts
const health = await ovok.health.check();

if (!health.ok) {
  throw new Error('Ovok API is not healthy');
}
```

A healthy API confirms the connection only. It does not grant access to project data.

## Test your integration [#test-your-integration]

1. Run the health check from the previous step.
2. Confirm that `health.ok` is `true`.
3. If the call rejects, read the error class. [Errors and retries](./errors-and-retries.mdx) explains each one.

| Scenario | How to trigger it | Expected result |
| --- | --- | --- |
| The API answers | Use `https://api.sandbox.ovok.com` as `baseUrl` | `health.ok` is `true` |
| The API cannot be reached | Point `baseUrl` at a host that does not answer | The call rejects with `OvokConnectionError` |

## See also [#see-also]

- [The Ovok client](./next-client.mdx): namespaces, paging and runtimes.
- [Sign users in](./guides/sign-in.mdx)
- [React integration](./react.mdx)
- [Errors and retries](./errors-and-retries.mdx)
