About Headless Projects

Wix Headless enables you to take advantage of Wix's business management platform from any app or site you create, on any platform.

The JavaScript SDK lets you access and manage a Headless project's business data using the APIs in the Backend Modules section of this reference.

For example, you can create a site's frontend using any framework and use Wix Headless to handle the site's blog, CRM, and product catalogue.

In order to make authenticated API calls from your code, you must set up a Wix Client.

Authentication with a Wix Client

There are 2 ways to create a client to handle authentication for Headless projects depending on the required functionality:

  • Create a client with OAuth for visitors and members.
  • Create a client with an API key for admins.

Learn more about the Wix Client in the reference.

Create a client with OAuth

When developing functionality for use by anonymous visitors or logged-in members, create a client with OAuth. You can do this by initializing the client using the OAuth authentication strategy.

With this client, your site or app can recognize individual visitors and members and access their data, such as the items they've added to the cart.

Note: Not every function in the SDK can be called using site visitor and member authentication. For more information, read About Identities.

For detailed instructions, see Create a Client with OAuth.

Create a client with an API key

When developing functionality that requires administrative access, create a client with an API key. You can do this by initializing the client using the API key authentication strategy.

When generating an API key, you grant it a custom set of permissions for accessing or managing business data, including members, orders, products, events, bookings, and more.

With this client, you can perform administrative operations at the site or account level, such as creating or deleting members, managing orders for site visitors, or creating a product.

For detailed instructions, see Create a Client with an API Key.

Templates and tutorials

Templates and tutorials for headless projects are available via the menu in the Wix Headless portal.

To quickly get started with your first Headless project, see our Quick Start article.

Was this helpful?
Yes
No