Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Create a Client with an API Key

> **Share your feedback**<br/>
> [Reach out to us](fallback::https://www.wix.com/support-chatbot?nodeId=407241cc-92c5-42e8-b466-a74e2889df9a&referral=headless) with feedback and suggestions to improve the Wix Headless experience, and join the [Headless channel](fallback::https://discord.gg/MK5VZ9Nu) of the Devs on Wix Discord community to discuss features and connect with our growing community of developers.

Once you have [generated an API key and obtained the IDs](resourceId::b810a32e-8d73-4d88-b19c-b64f1db0a990*fallback::https://github.com/wix-private/developer-docs/blob/958e4143cd2833885f5f0239856e9a4351a96692/headless-docs/setup/generate-an-api-key.md*original::../../setup/generate-an-api-key.md) for your Wix account and Wix site, you can use them to create an SDK client that uses your API key to authenticate.

## Prerequisites

- [Create a Project](resourceId::672efad8-7bc6-42bc-a408-8c0f1132ec1d*fallback::https://github.com/wix-private/developer-docs/blob/958e4143cd2833885f5f0239856e9a4351a96692/headless-docs/setup/create-a-project.md*original::../../setup/create-a-project.md)
- [Generate and API Key for Admins](resourceId::b810a32e-8d73-4d88-b19c-b64f1db0a990*fallback::https://github.com/wix-private/developer-docs/blob/958e4143cd2833885f5f0239856e9a4351a96692/headless-docs/setup/generate-an-api-key.md*original::../../setup/generate-an-api-key.md)

> **Note:** Before you start, make sure you are using Node.js version 18 or higher.

## Install packages

Install `@wix/sdk` and the packages for the domain-specific APIs you wish to work with. Domain-specific packages follow the naming convention `@wix/{domain}`. For example:

```console
npm install @wix/sdk
npm install @wix/stores
```

or

```console
yarn add @wix/sdk
yarn add @wix/stores
```

## Import modules

To use the APIs you have installed, import `createClient` from the `@wix/sdk` package along with an authentication strategy, and import functionality from the desired domain-specific packages you installed. For example:

```js
import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { contacts } from '@wix/contacts';
import { collections, products } from '@wix/stores';
```

## Create a client

To get started connecting an external client with a Wix site, use the [`createClient()`](portalId::b85dea5b-341b-493b-b99e-4d4ca12baaa2resourceId::2494d8e9-42aa-4802-8f67-b01c1a013c2c*fallback::https://dev.wix.com/docs/sdk/api-reference/sdk/wix-client) function imported from the `@wix/sdk` package.

```js
const myWixClient = createClient({
  auth: ApiKeyStrategy({
    apiKey: '<API_KEY>',
    siteId: '<SITE_ID>',
    accountId: '<ACCOUNT_ID>',
  }),
  modules: {
    contacts: contacts.contacts,
    products: stores.products,
  },
});
```

The `createClient()` function returns a new Wix client.

- The `modules` parameter property contains key:value pairs. Each value is an imported module you wish to enable in the client, and the key defines the name to use for working with that module.
- The `auth` parameter property contains the authentication method and credentials for connecting with your Wix project. To create a client for your Wix project, pass `ApiKeyStrategy()` with an object containing:
  - `apiKey`: An API key that you generated in the [API Key Manager](fallback::https://manage.wix.com/account/api-keys).
  - `siteId`: ID of the Wix site or project you are working with. Required for site-level API calls.
  - `accountId`: ID of the Wix account the API key belongs to. Required for account-level API calls.

Once you have created a client successfully, you can begin using it to call functions in the API Reference.

## Example

```javascript
import { createClient } from '@wix/sdk';
import { products } from '@wix/stores';

const myWixClient = createClient({
  auth: ApiKeyStrategy({
    apiKey: '<API_KEY>',
    siteId: '<SITE_ID>',
    accountId: '<ACCOUNT_ID>',
  }),
  modules: {
    cart,
    products,
  },
});

// ...

const { items } = await myWixClient.products
  .queryProducts()
  .startsWith('name', 'shoes')
  .limit(4)
  .find();
```