Skip to main content

1. Enable the Headless API

1

Open the admin panel

Sign in at https://your-site.com/dashboard. This page requires the MANAGE_SETTINGS permission.
2

Open Settings → Headless API

Turn on Headless API Status. The change is saved immediately.
3

Copy the public key

Use the Copy button to take the key that starts with pk_live_. The page also shows the API URL: https://your-site.com/headless/v1
While the Headless API is off, every request returns 404 HEADLESS_DISABLED. See Dashboard settings for the details of each setting.

2. Send your first request

A successful response contains the site name, version, active modules, currencies, captcha settings and the branding rule:

3. Log in

Send data.token from the response in later requests:

4. The same with the SDK

5. If you call the API from a browser

Browser requests carry an Origin header and are accepted only from allowed origins. While developing, add http://localhost:3000 to Settings → Headless API → Allowed Origins. Server-side requests (for example Next.js Server Components) carry no Origin and are always accepted.

Common errors

See API basics for the full picture.

Next step

Set up a ready theme

Don’t start from scratch: create a working Next.js theme with one command.