Setup Overview
Share your feedback
Reach out to us with feedback and suggestions to improve the Wix Headless experience, and join the Headless channel of the Devs on Wix Discord community to discuss features and connect with our growing community of developers.
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
If your business already has a live Wix site and you want to enable additional clients to access and manage the site's business data via APIs, you can skip to the next step. Otherwise, begin by creating a new project.
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.
- Visitors and Members (OAuth): An external site or app for use by customers, such as anonymous visitors and logged-in members. To get started with this authorization strategy, start by creating an OAuth app.
- Admin (API Key): An external site or app with customized administrative access to your Wix account's sites and projects. To get started with this authorization strategy, start by generating an API key.
In some cases, you may want to use more than one authorization strategy or use a number of API keys in the same site or app.
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 two 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.