> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt ## Resource: Velo to SDK API Mapping ## Article: Velo to SDK API Mapping ## Article Link: https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/develop-with-the-sdk/velo-to-sdk-api-mapping.md ## Article Content: # Velo to SDK API Mapping You can now use the [Wix JavaScript SDK](https://dev.wix.com/docs/sdk.md) instead of the Velo API for most functionality when developing sites or building apps with Blocks. Learn more about [developing websites with the SDK](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/develop-with-the-sdk/develop-websites-with-the-sdk.md). Wix's transition to the SDK is a gradual process. At this stage, not all Velo APIs have equivalent SDK modules that can be used for site development or for app creation with Blocks. For functionality that is not yet supported in the SDK, use Velo APIs alongside the SDK. This article outlines which [Velo APIs you should continue to use](#velo-apis-you-should-continue-to-use), and how to [find your Velo APIs' functionality in the SDK](#finding-sdk-replacements-for-velo-apis). ## Velo APIs you should continue to use The Velo APIs that should still be used at this stage fall into 2 categories: - **Velo-Only APIs**: These APIs are imported from Velo modules whose functionality the SDK doesn't support. You can find these APIs in the [Velo-Only APIs](https://dev.wix.com/docs/velo/velo-only-apis/about-velo-only-apis-and-the-sdk.md) section of the Velo API reference. - [`$w`](https://dev.wix.com/docs/velo/velo-only-apis/$w/introduction.md) - [`$widget`](https://dev.wix.com/docs/velo/velo-only-apis/$widget/introduction.md) - [`wix-configs-backend`](https://dev.wix.com/docs/velo/velo-only-apis/wix-configs-backend/introduction.md) - [`wix-http-functions`](https://dev.wix.com/docs/velo/velo-only-apis/wix-http-functions/introduction.md) - [`wix-realtime-backend`](https://dev.wix.com/docs/velo/velo-only-apis/wix-realtime-backend/introduction.md) - [`wix-application`](https://dev.wix.com/docs/velo/velo-only-apis/wix-application/introduction.md): Most `wix-application` functionality isn't yet available in the SDK. The SDK currently supports only identifying the app instance, similar to what [`getDecodedAppInstance()`](https://dev.wix.com/docs/velo/velo-only-apis/wix-application/get-decoded-app-instance.md) provides in Velo. To identify the app instance using the SDK: - In backend code, [call `getTokenInfo()` or `getAppInstance()` in a backend function](https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/identify-the-app-instance-in-backend-environments.md#blocks-backend-function). - In frontend code, [simply call your backend function](https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/identify-the-app-instance-in-frontend-environments.md#blocks-backend-function). - [`wix-editor`](https://dev.wix.com/docs/velo/velo-only-apis/wix-editor/introduction.md) - **Events and Service Plugins**: These APIs work by file and name conventions. They may have SDK counterparts, but the SDK versions don't work for site development and for app creation with Blocks. You can find them in the [Events & Service Plugins](https://dev.wix.com/docs/velo/events-service-plugins/about-events-service-plugins-and-the-sdk.md) section of the Velo API reference. ## Finding SDK replacements for Velo APIs The functionality of the Velo APIs listed in the [APIs](https://dev.wix.com/docs/velo/apis/about-velo-apis-and-the-sdk.md) section of the Velo API reference are mostly supported by the SDK. These APIs each fall into one of the following categories: - [Universal APIs](#universal-apis) - [Backend APIs](#backend-apis) - [Frontend APIs](#frontend-apis) - [Unique cases](#unique-cases) To learn how to migrate your code from Velo to SDK, see [Migrate from Velo to the SDK](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/develop-with-the-sdk/migrate-from-velo-to-the-sdk.md). ### Universal APIs Velo APIs that end in `.v2`, such as `wix-bookings.v2`, are universal APIs. [`wix-blog-backend`](https://dev.wix.com/docs/velo/apis/wix-blog-backend/introduction.md), [`wix-ecom-backend`](https://dev.wix.com/docs/velo/apis/wix-ecom-backend/introduction.md), [`wix-pro-gallery-backend`](https://dev.wix.com/docs/velo/apis/wix-pro-gallery-backend/introduction.md), and [`wix-tags.v1`](https://dev.wix.com/docs/velo/apis/wix-tags-v1/introduction.md) are also universal APIs. Universal APIs have direct equivalents in the SDK. These are the backend SDK modules with similar naming to the Velo counterparts. For example, the [`bookings`](https://dev.wix.com/docs/sdk/backend-modules/bookings/introduction.md) SDK module is a direct replacement for the Velo [`wix-bookings.v2`](https://dev.wix.com/docs/velo/apis/wix-bookings-v2/introduction.md) API.
Exceptions: - [`wix-secrets-backend.v2`](https://dev.wix.com/docs/velo/apis/wix-secrets-backend-v2/introduction.md): This is a [backend API](#backend-apis), but it does have an equivalent SDK module.
> **Note:** Because the Wix SDK continues to be updated, an equivalent SDK module may have more functionality than its equivalent Velo API, so they may not look identical. ### Backend APIs Velo APIs that end in `-backend`, such as `wix-bookings-backend`, are backend APIs. Most backend APIs have corresponding [universal APIs](#universal-apis) that contain the same functionality. For example, `wix-bookings.v2` contains `wix-bookings-backend` functionality. To migrate your code that uses backend APIs to the SDK, use the corresponding universal API's equivalent SDK module. For example, use the [`bookings`](https://dev.wix.com/docs/sdk/backend-modules/bookings/introduction.md) SDK module instead of the Velo [`wix-bookings-backend`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/introduction.md) API. Backend Velo APIs use the `suppressAuth` property to prevent permission checks from running. The equivalent functionality in the SDK is elevation. Learn more about [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions.md).
Exceptions: - [`wix-blog-backend`](https://dev.wix.com/docs/velo/apis/wix-blog-backend/introduction.md): This is a [universal API](#universal-apis). - [`wix-cache-backend`](https://dev.wix.com/docs/velo/apis/wix-cache-backend/cache/introduction.md): The [`cache`](https://dev.wix.com/docs/sdk/backend-modules/cache/cache/invalidate-cache.md) SDK module contains this API's functionality. - [`wix-chat-backend`](https://dev.wix.com/docs/velo/apis/wix-chat-backend/introduction.md): The [`inbox.messages`](https://dev.wix.com/docs/sdk/backend-modules/inbox/messages/setup.md) SDK submodule contains this API's functionality. - [`wix-ecom-backend`](https://dev.wix.com/docs/velo/apis/wix-ecom-backend/introduction.md): This is a [universal API](#universal-apis). - [`wix-pay-backend`](https://dev.wix.com/docs/velo/apis/wix-pay-backend/introduction.md): This API doesn't currently have an SDK replacement. For now, continue using the Velo API. - [`wix-payment-provider-backend`](https://dev.wix.com/docs/velo/apis/wix-payment-provider-backend/introduction.md): The [`payments.pspCallbacks`](https://dev.wix.com/docs/sdk/backend-modules/payments/psp-callbacks/setup.md) SDK submodule contains this API's functionality. - [`wix-pro-gallery-backend`](https://dev.wix.com/docs/velo/apis/wix-pro-gallery-backend/introduction.md): This is a [universal API](#universal-apis). - [`wix-site-backend`](https://dev.wix.com/docs/velo/apis/wix-site-backend/introduction.md): Migrating this API is a [unique case](#wix-site-backend).
### Frontend APIs Velo APIs that end in `-frontend`, such as `wix-bookings-frontend`, are frontend APIs. [`wix-mobile`](https://dev.wix.com/docs/velo/apis/wix-mobile/introduction.md) and [`wix-navigate-mobile`](https://dev.wix.com/docs/velo/apis/wix-navigate-mobile/introduction.md) are also frontend APIs. Frontend APIs have direct equivalents in the SDK. These are the frontend SDK modules with similar naming to the Velo counterparts. For example, the [`bookings`](https://dev.wix.com/docs/sdk/frontend-modules/bookings/introduction.md) SDK frontend module is a direct replacement for the Velo [`wix-bookings-frontend`](https://dev.wix.com/docs/velo/apis/wix-bookings-frontend/introduction.md) API. Frontend SDK methods are asynchronous, even when the Velo equivalent is synchronous.
Exceptions: - [`wix-pay-frontend`](https://dev.wix.com/docs/velo/apis/wix-pay-frontend/currencies/introduction.md): Migrating this API is a [unique case](#wix-pay-frontend). - [`wix-storage-frontend`](https://dev.wix.com/docs/velo/apis/wix-storage-frontend/introduction.md): This API's equivalent SDK module, [`storage`](https://dev.wix.com/docs/sdk/frontend-modules/storage/introduction.md), has asynchronous methods. The equivalent Velo methods are synchronous.
### Unique cases The following Velo APIs have a unique way to implement their functionality in the SDK. #### `wix-auth` The [`wix-auth`](https://dev.wix.com/docs/velo/apis/wix-auth/introduction.md) Velo API has equivalent functionality in the [`essentials.auth`](https://dev.wix.com/docs/sdk/core-modules/essentials/auth.md) SDK submodule. #### `wix-bookings.v1` The `wix-bookings.v1` Velo API has a corresponding [universal API](#universal-apis), [`wix-bookings.v2`](https://dev.wix.com/docs/velo/apis/wix-bookings-v2/introduction.md). Therefore, use the the [`bookings`](https://dev.wix.com/docs/sdk/backend-modules/bookings/introduction.md) SDK module instead of `wix-bookings.v1`. #### `wix-dashboard` The [`wix-dashboard`](https://dev.wix.com/docs/velo/apis/wix-dashboard/introduction.md) Velo API has an equivalent [`dashboard`](https://dev.wix.com/docs/sdk/host-modules/dashboard/introduction.md) SDK module. This module is a [host module](https://dev.wix.com/docs/sdk/host-modules/about-host-modules.md). #### `wix-data` The [`wix-data`](https://dev.wix.com/docs/velo/apis/wix-data/introduction.md) Velo API has a replacement [`items`](https://dev.wix.com/docs/sdk/backend-modules/data/items/introduction.md) SDK submodule in the `data` SDK module. Note that while this submodule closely mirrors `wix-data`, it's not a direct equivalent. Learn more about [migrating from `wix-data` to the Data Items SDK](https://dev.wix.com/docs/velo/apis/wix-data/migrate-to-the-sdk.md). #### `wix-fetch` Use the native `fetch()` to access the functionality of [`wix-fetch`](https://dev.wix.com/docs/velo/apis/wix-fetch/introduction.md) in the SDK. The `wix-fetch` Velo API has no SDK replacement. This API contains 2 methods: - `fetch()`: You can use the native `fetch()` by calling this method on the frontend or backend without importing it when using the SDK. - `getJSON()`: This method does not exist in the SDK. You can convert your `getJSON()` calls to `fetch()` instead. To get the JSON data from the `fetch()` response, call the `json()` method. #### `wix-pay-frontend` The [`wix-pay-frontend`](https://dev.wix.com/docs/velo/apis/wix-pay-frontend/introduction.md) Velo API has 2 sections and each section is handled differently: - [`startPayment()`](https://dev.wix.com/docs/velo/apis/wix-pay-frontend/start-payment.md): This Velo method doesn't currently have an SDK replacement. For now, continue using the Velo method. - [`currencies`](https://dev.wix.com/docs/velo/apis/wix-pay-frontend/currencies/introduction.md): This Velo API has an equivalent [`pay.currencies`](https://dev.wix.com/docs/sdk/frontend-modules/pay/currencies/introduction.md) SDK frontend submodule. #### `wix-search` The [`wix-search`](https://dev.wix.com/docs/velo/apis/wix-search/introduction.md) Velo API doesn't currently have an SDK replacement. For now, continue using the Velo API. #### `wix-site-backend` The [`wix-site-backend`](https://dev.wix.com/docs/velo/apis/wix-site-backend/introduction.md) Velo API has 2 sections and each section is handled differently: - [`invalidateCache()`](https://dev.wix.com/docs/velo/apis/wix-site-backend/invalidate-cache.md): This Velo method doesn't currently have an SDK replacement. For now, continue using the Velo method. - [`GeneralInfo`](https://dev.wix.com/docs/velo/apis/wix-site-backend/general-info/introduction.md): This functionality can be implemented using [`getSiteProperties()`](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties.md) from the `business-tools.siteProperties` SDK submodule. #### `wix-site-plugins.v1` The [`wix-site-plugins.v1`](https://dev.wix.com/docs/velo/apis/wix-site-plugins-v1/introduction.md) Velo API has an equivalent [`site-plugins`](https://dev.wix.com/docs/sdk/backend-modules/site-plugins/plugins/introduction.md) SDK module. #### `wix-web-module` The [`wix-web-module`](https://dev.wix.com/docs/velo/apis/wix-dashboard/introduction.md) Velo API has an equivalent [`web-methods`](https://dev.wix.com/docs/sdk/core-modules/web-methods/introduction.md) SDK module. This module is a core module. #### `wix-widget` The [`wix-widget`](https://dev.wix.com/docs/velo/velo-only-apis/wix-widget/introduction.md) Velo API has an equivalent [`widget`](https://dev.wix.com/docs/sdk/host-modules/editor/widget/introduction.md) SDK submodule. #### Velo packages [Velo packages](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/working-with-velo-packages.md) don't currently have equivalent SDK packages. In the future, equivalent SDK packages will gradually be released. ## See also - [Develop Websites with the SDK](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/develop-with-the-sdk/develop-websites-with-the-sdk.md) - [Migrate from Velo to the SDK](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/develop-with-the-sdk/migrate-from-velo-to-the-sdk.md) - [About Site Development](https://dev.wix.com/docs/sdk/articles/get-started/about-site-development.md)