Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { editor } from '@wix/urls';

const wixClient = createClient({
  modules: { editor },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getEditorUrls() {
  const response = await wixClient.editor.getEditorUrls();
}

getEditorUrls() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { editor } from '@wix/urls';

const wixClient = createClient({
  modules: { editor },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getEditorUrls() {
  const response = await wixClient.editor.getEditorUrls();
}

getEditorUrls() with Dashboard app access

getEditorUrls

GetEditorUrlsResponse

# About Editor URLs

On occasion, your app might want to redirect a site builder to their site's editor or to preview their site with any unpublished changes - for example, to lead them to make changes in your app's settings panel in the editor, 
or to review changes to the app or the site.

## Before you begin
It’s important to note the following points before starting to code:
* Embedded script extensions won't be displayed in the preview.


## Terminology
* **Editor**: The platform site builders' use to build and edit their sites. Wix offers 3 editors for site builders:
  * [Wix Studio](https://support.wix.com/en/wix-studio)
  * [Wix Editor](https://support.wix.com/en/using-the-wix-editor)
  * [Editor X](https://support.wix.com/en/about-editor-x-2920765) - partially deprecated
* **Preview**: A feature that enables site builders to see what any changes made on their site (in the editor, or in your app) will look like to visitors, without publishing the site. Wix recommends that site builders preview their sites to test how new changes and updates look before publishing them. 


To use the Editor API, install the `@wix/urls` package using npm or Yarn:
  ```console
npm install @wix/urls
```

or

```console
yarn add @wix/urls
```

Then import `{ editor }` from `@wix/urls`:

```js
import { editor } from '@wix/urls'
```
  

urls_editor

EditorType

EditorUrls

Editor type.
Supported values:
- `WIX_EDITOR`: The classic Wix Editor.
- `EDITOR_X`: Deprecated. Expected sunset date: July 1, 2024.
- `WIX_STUDIO`: Wix's Editor built for agencies and enterprises.

About Editor URLs

Before you begin

Terminology

Setup

Permission Scopes