Setup Overview

The following is an overview of the steps required to get started with Wix Headless. Follow the links in each step to get your project set up and ready for development.

Step 1 | Create and set up a Wix project

A Headless project is essentially a Wix site that uses Wix's business management platform without necessarily using a Wix frontend. This approach allows you to build your own custom frontend while leveraging Wix's powerful business management tools. Headless projects appear in your Wix account alongside your Wix sites, making it easy to manage all your Wix projects in one place. To get started, create a Headless project.

If you already have a live Wix site, you can still use Headless features to create additional interfaces that access and manage a site's data using APIs. In this case, you don't need to create a new Headless project. Instead, continue with the next steps using your existing Wix site.

Step 2 | Add apps to your project

To take advantage of business solutions, such as eCommerce, Bookings, Pricing Plans, or Events, add the apps relevant to your needs. If you didn't already do this when creating your Wix project, add apps to your project now.

Step 3 | Choose your authorization strategy

To work with Wix APIs in your Headless site or app, you need to be authorized to call APIs. The authorization strategy you should choose depends on what kind of headless site or app you are developing.

In some cases, you may want to use more than 1 authorization strategy or use a number of API keys in the same site or app.

Note: The authorization strategy serves 2 purposes:

  • Authorizes your app to call Wix APIs.
  • Directs your calls to Wix APIs to a site or project.

To learn more about authorization strategies, see Authorization Strategies.

Step 4 | Choose to work with the JavaScript SDK or the REST API

At this point your project is all set up and you're almost ready to start coding. Next, you need to choose how you're going to call Wix APIs.

There are 2 ways to interact with the Wix platform from the site or app you're building:

  • JavaScript SDK: If you're coding in JavaScript, use the JavaScript SDK to call Wix APIs.
  • REST API: If you're not coding in JavaScript, use the REST API to call Wix APIs.

In some cases, you may want to work with both the JavaScript SDK and the REST API.

Step 5 | Invite collaborators

Invite collaborators to your project so they can view and manage your Headless Settings, including creating and connecting new headless clients. This makes it easier to share responsibility across your team and streamline development.

Did this help?