Technical Requirements

Overview

Before you start development, go over our technical requirements and ask your account manager if you have any questions about how to implement them.

We’ll check your app carefully against our requirements during the app approval process.

Note:
We regularly update our requirements based on industry changes, new features in Wix, issues that come up as we review apps, etc.
Integration Basics
  • The client-side supports HTML5; doesn’t use Adobe Flash. The server-side code can be in any language.
  • Identify the site using the instance parameter. The instance parameter includes the instanceId, which is a unique identifier of your app in a specific site.
  • Have both a site component and a back-office service? Create a multicomponent app.
  • Save app data for at least 30 days after users delete the app. This makes it easier for a user to start using your app again. Save any customizations the user made, forms that site visitors submitted, analytics, etc.
  • Share relevant data with the WixHive. To gives users a seamless experience, apps and other Wix components share information about the user’s contacts and site visitor activity (purchases, reservations, etc) via our data-sharing platform, the WixHive.
Security & Privacy
  • Support HTTPS. Every endpoint in your app must support HTTPS.
  • Verify the user’s identity. Here’s how.
  • Keep data secure. Encrypt all sensitive data, and don’t store sensitive data in cookies.
  • Prevent XSS attacks in all text input fields. This ensures that no one can enter malicious code in your app.
  • Show payment settings to site owners only. If your settings panel or dashboard component includes payment settings (like connecting a paypal account), hide these settings from contributors.
Quality & Functionality
  • Develop your app according to the approved mockups. Once we approve your mockups, don’t make any UI/UX changes. If there’s something you must change, talk to your account manager.
  • Test for bugs and other issues. Before you submit your app for review, thoroughly test your app. You’ll also need to fix any issues we find during our technical review.
Billing & Premium

Handle billing through Wix. Use the SDK to open open Wix’s billing page. Don’t take users to your site for upgrades or payment.

Site Components

General

  • Use our UI-lib starter template to create your app. Our template makes it easy for you to start, and it’ll prevent a lot of issues in the later app review.
  • Open new windows as Wix popup or modal windows. Use our SDK to open the Wix popup or Wix modal in the site component. Don’t use browser native popups, such as: window.alert(), window.prompt() and window.confirm().

App Setup & Management

  • Integrate your app’s colors and fonts with the site. Use the site’s color palette and font style.
  • When users change the app, show these changes in the Wix Editor right away. Learn more.  
  • Don’t change the app on the live site until the user publishes. Learn more.
  • Differentiate between components in the same site. Users can add the app more than once, and they must be able to customize each one differently. Here’s how to support multiple widget components and multiple page components.
  • When users copy the app, copy its settings too (Widgets & Fixed-Position Widgets only). Use the originCompId query parameter to keep the original component’s design and other settings.

Responsive & Mobile-Optimized

This requirement is for widget and page components only (not fixed-position widgets):

Make your app responsive and optimize for mobile. Make sure your app looks great at any size, and on any device. Learn more.

Important:
If you’re not using media queries, then you must have a dedicated mobile endpoint.

Accessibility & SEO

  • Make the site component accessible to all site visitors – including those with disabilities. Now that some countries require websites to be accessible, your app must comply with accessibility standards so that users can make their site accessible. Here’s how.  
  • Only use <h1> for internal pages in a page component. Don’t use <h1> anywhere else. Otherwise, users may end up with more than one <h1> on the page – and this causes accessibility & SEO issues.
  • Have content that’s meaningful for SEO? Optimize your app for SEO and create a dedicated SEO endpoint. Learn more about SEO for widgets and pages.
App Settings Panel
  • Don’t make any CSS changes to the UI controls or panel. Don’t change any CSS properties (unless you’re asked to do so by your account manager). We’ll ask you to change it back, and it’ll delay the later app review.
  • Open new windows open as a Wix modal. Use our SDK to open the Wix Settings modal. Don’t use browser native popups, such as: window.alert(), window.prompt() and window.confirm().
  • Do users access or upload media files for your app? Use our SDK open the Wix Media Manager.
Dashboard Components
  • Include our JavaScript SDK script tag. Add a reference to our Javascript SDK in the HTML document.
  • Open new windows as a Wix modal. Use our SDK to open the Wix Dashboard modal. Don’t use browser native popups, such as: window.alert(), window.prompt() and window.confirm().
  • Do users access or upload media files for your app? Use our SDK open the Wix Media Manager.

Was this page helpful?

What can we do to improve it?

What did you like about it?