[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / PersApiClient

# Class: PersApiClient

## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/persapiclient#constructor)


### Methods

- [ensureValidToken](/sdk-reference/classes/persapiclient#ensurevalidtoken)
- [setEvents](/sdk-reference/classes/persapiclient#setevents)
- [get](/sdk-reference/classes/persapiclient#get)
- [post](/sdk-reference/classes/persapiclient#post)
- [put](/sdk-reference/classes/persapiclient#put)
- [patch](/sdk-reference/classes/persapiclient#patch)
- [delete](/sdk-reference/classes/persapiclient#delete)
- [getAuthService](/sdk-reference/classes/persapiclient#getauthservice)
- [getConfig](/sdk-reference/classes/persapiclient#getconfig)
- [getOriginalConfig](/sdk-reference/classes/persapiclient#getoriginalconfig)
- [setDataSource](/sdk-reference/classes/persapiclient#setdatasource)
- [updateDataSource](/sdk-reference/classes/persapiclient#updatedatasource)
- [setPlatform](/sdk-reference/classes/persapiclient#setplatform)
- [getDataSource](/sdk-reference/classes/persapiclient#getdatasource)
- [getPlatform](/sdk-reference/classes/persapiclient#getplatform)
- [validateTracking](/sdk-reference/classes/persapiclient#validatetracking)


## Constructors

### constructor

• **new PersApiClient**(`httpClient`, `config`): [`PersApiClient`](/sdk-reference/classes/persapiclient)

Creates a new PERS API Client instance

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `httpClient` | [`HttpClient`](/sdk-reference/interfaces/httpclient) | Platform-specific HTTP client implementation |
| `config` | [`PersConfig`](/sdk-reference/interfaces/persconfig) | Configuration options for the API client |


#### Returns

[`PersApiClient`](/sdk-reference/classes/persapiclient)

#### Defined in

[core/pers-api-client.ts:58](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L58)

## Methods

### ensureValidToken

▸ **ensureValidToken**(): `Promise`<`void`>

Ensures valid authentication token before making requests

Validates the current token and automatically refreshes if expired or near expiration.
Uses a 120-second margin - tokens are refreshed if they expire within 2 minutes.

This method is called automatically before each request but can also be called
manually when needed (e.g., app resume from background).

#### Returns

`Promise`<`void`>

Promise that resolves when token validation is complete

**`Throws`**

Error if token refresh fails

**`Example`**

```typescript
// Validate tokens when app becomes active
await apiClient.ensureValidToken();
```

#### Defined in

[core/pers-api-client.ts:134](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L134)

### setEvents

▸ **setEvents**(`events`): `void`

Set event emitter for error event emission

#### Parameters

| Name | Type |
|  --- | --- |
| `events` | [`PersEventEmitter`](/sdk-reference/classes/perseventemitter) |


#### Returns

`void`

#### Defined in

[core/pers-api-client.ts:331](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L331)

### get

▸ **get**<`T`>(`endpoint`, `responseType?`): `Promise`<`T`>

Performs an authenticated GET request

#### Type parameters

| Name | Description |
|  --- | --- |
| `T` | Expected response type |


#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `endpoint` | `string` | API endpoint path (without base URL) |
| `responseType?` | `"json"` | `"blob"` | `"text"` | `"arraybuffer"` | Expected response format |


#### Returns

`Promise`<`T`>

Promise resolving to typed response data

**`Example`**

```typescript
const user = await client.get<User>('/users/123');
const csvData = await client.get('/export/data', 'blob');
```

#### Defined in

[core/pers-api-client.ts:349](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L349)

### post

▸ **post**<`T`>(`endpoint`, `body?`, `options?`): `Promise`<`T`>

Performs an authenticated POST request

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name | Type |
|  --- | --- |
| `endpoint` | `string` |
| `body?` | `unknown` |
| `options?` | `Object` |
| `options.bypassAuth?` | `boolean` |
| `options.isRefreshRequest?` | `boolean` |


#### Returns

`Promise`<`T`>

#### Defined in

[core/pers-api-client.ts:356](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L356)

### put

▸ **put**<`T`>(`endpoint`, `body?`): `Promise`<`T`>

Generic PUT request

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name | Type |
|  --- | --- |
| `endpoint` | `string` |
| `body?` | `unknown` |


#### Returns

`Promise`<`T`>

#### Defined in

[core/pers-api-client.ts:363](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L363)

### patch

▸ **patch**<`T`>(`endpoint`, `body?`): `Promise`<`T`>

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name | Type |
|  --- | --- |
| `endpoint` | `string` |
| `body?` | `unknown` |


#### Returns

`Promise`<`T`>

#### Defined in

[core/pers-api-client.ts:368](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L368)

### delete

▸ **delete**<`T`>(`endpoint`): `Promise`<`T`>

Generic DELETE request

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name | Type |
|  --- | --- |
| `endpoint` | `string` |


#### Returns

`Promise`<`T`>

#### Defined in

[core/pers-api-client.ts:374](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L374)

### getAuthService

▸ **getAuthService**(): [`AuthService`](/sdk-reference/classes/authservice)

- For AuthManager use only


#### Returns

[`AuthService`](/sdk-reference/classes/authservice)

#### Defined in

[core/pers-api-client.ts:446](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L446)

### getConfig

▸ **getConfig**(): [`PersConfig`](/sdk-reference/interfaces/persconfig) & `Required`<`Pick`<[`PersConfig`](/sdk-reference/interfaces/persconfig), `"environment"` | `"apiVersion"` | `"timeout"` | `"retries"`>>

Get current configuration (returns merged config)

#### Returns

[`PersConfig`](/sdk-reference/interfaces/persconfig) & `Required`<`Pick`<[`PersConfig`](/sdk-reference/interfaces/persconfig), `"environment"` | `"apiVersion"` | `"timeout"` | `"retries"`>>

#### Defined in

[core/pers-api-client.ts:453](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L453)

### getOriginalConfig

▸ **getOriginalConfig**(): [`PersConfig`](/sdk-reference/interfaces/persconfig)

Get original user configuration

#### Returns

[`PersConfig`](/sdk-reference/interfaces/persconfig)

#### Defined in

[core/pers-api-client.ts:460](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L460)

### setDataSource

▸ **setDataSource**(`dataSource`): `void`

Set data source tracking info (replaces existing)

#### Parameters

| Name | Type |
|  --- | --- |
| `dataSource` | `DataSource` |


#### Returns

`void`

#### Defined in

[core/pers-api-client.ts:469](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L469)

### updateDataSource

▸ **updateDataSource**(`dataSource`): `void`

Update data source tracking info (merges with existing)

#### Parameters

| Name | Type |
|  --- | --- |
| `dataSource` | `Partial`<`DataSource`> |


#### Returns

`void`

#### Defined in

[core/pers-api-client.ts:474](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L474)

### setPlatform

▸ **setPlatform**(`platform`): `void`

Set platform info for analytics

#### Parameters

| Name | Type |
|  --- | --- |
| `platform` | `Platform` |


#### Returns

`void`

#### Defined in

[core/pers-api-client.ts:479](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L479)

### getDataSource

▸ **getDataSource**(): `undefined` | `DataSource`

Get current data source config

#### Returns

`undefined` | `DataSource`

#### Defined in

[core/pers-api-client.ts:484](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L484)

### getPlatform

▸ **getPlatform**(): `undefined` | `Platform`

Get current platform info

#### Returns

`undefined` | `Platform`

#### Defined in

[core/pers-api-client.ts:489](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L489)

### validateTracking

▸ **validateTracking**(): `Object`

Validate tracking configuration (for debugging)

#### Returns

`Object`

| Name | Type |
|  --- | --- |
| `isValid` | `boolean` |
| `warnings` | `string`[] |


#### Defined in

[core/pers-api-client.ts:494](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/core/pers-api-client.ts#L494)