Search Results for: SDK 1.30.0

    • SDK
    • Using the SDK

    We release new versions of our JavaScript SDK regularly. Update your app to use the latest version by replacing the version number in the script tag. Note the following: We document the latest SDK version for each method. If a method is updated, we update its SDK version accordingly. For e...

    • SDK
    • Wix.Worker

    Utils.getViewMode( ) → String SDK 1.30.0+New EditorOld EditorLive SitePreviewWorker Returns a String which represents the current view mode.

    • Changelog

    SDK 1.96.0 We released a few accessibility updates, so make sure your app is updated to use the latest SDK version. Wix.revalidateSession now works in the live site as well. To use this method in the live site, make sure to also listen for the INSTAN...

    • WixHive
    • Introduction

    The WixHive collects information from the user's website or business, including Contacts and Activities. This information is saved in the scope of a website, and every component installed in that website should report all data it collects. Using the information collected by the website, all...

    • UI-lib
    • App Settings Panel

    Have a multicomponent app? Make it easy for users to add your app’s site components - they’ll be able to add widgets that weren’t added when the user installed your app, or add your page component again (if you enabled this option in the Dev Center). How to ...

    • Monetization
    • Beta: In-App Purchases

    Here’s how to implement in-app purchases: Show users the right packages. When your App Settings panel/Dashboard component loads, use the SDK to get information about the user’s location. This way, you can show users the right packages based on their region and currency. Use Wix.Billing.get...

  • Wix
    • SDK
    • Wix

    replaceSectionState(state) Live SitePageSDK v1.65.0+ This method is like the pushState method, except that this method replaces the URL in the browser's history. Parameters: Name Type Description state String New state to push to the URL ...

    • UI/UX Basics
    • Site Components

    If you need to open a window or dialog box in your app: Use the Wix popup or modal. We’ll explain the differences below so you can choose which one is better for your app. Keep site visitors within the Wix platform. Don’t open windows in a new tab or use browser-native popups such as win...

    • SDK
    • Wix.Features

    isSupported(feature, callback) DashboardFixed-Position WidgetNew EditorPagePreviewSDK v1.45.0+Settings ModalSettings PanelWidgetWix Dashboard Checks if a feature is available for use. The feature name must be one of Wix.Features.Types listed below. Parameters: N...

    • SDK
    • Wix.Dashboard

    openBillingPage( ) SDK 1.31.0+Dashboard Allows the app to open the Wix billing page. Example: Wix.Dashboard.openBillingPage();

    • SDK
    • Wix.Styles

    Wix.Styles.getStyleId(callback) Fixed-Position WidgetLive SiteNew EditorPagePreviewSDK v1.65.0+Widget Returns the component’s styleId. The styleId represents a set of style parameters we’ve stored for a specific component - colors, fonts, numbers, and booleans. Once you kno...

    • UI/UX Basics
    • Dashboard Component

    The best way to get more conversions is to show users why they should upgrade to a recurring plan - and make it easy for them to do:   Mark premium features - add an icon next to premium features. When users hover over the icon, you can show a tooltip with more information about the featur...

    • Development
    • Page

    Follow our UI/UX guidelines for your page component’s size. Width: The default width of the page component is 980px, just like every other page in the site. When we call your widget endpoint, we’ll include the page’s width in the endpoint URL. Height: You’ll need to adjust the height accor...

    • SDK
    • Wix.Settings

    openSiteMembersSettingsDialog() New EditorSDK v1.74.0+Settings Panel Opens the settings for the Wix’s site members component, directly from your app. This method first closes all other open dialogs or panels in the editor. This method is relevant for apps that require site vis...

    • WixHive
    • Activities

    When you register your app, you can sign up to receive immediate notification when an Activity occurs. These events will be delivered to your app via webhooks and will include the Activity ID. To get the Activity data use the HTTP API or the JavaScript SDK with the relevant Activity ID. The...

    • Get Ready to Launch
    • App Requirements

    UI Panel is designed according to our standard panel structure and guidelines. This makes it easier for users to set up and use your app. Learn more by going through our App Settings Panel guide. No CSS changes were made to the UI controls or panel. Don’t change any CSS properties (unles...

    • SDK
    • Wix.Utils

    getViewMode() → String SDK 1.12.0+New EditorOld EditorLive SitePreviewWidgetFixed-Position WidgetPageSettings PanelSettings ModalModalPopup Returns a string which represents the current view mode. Example: var viewMode = Wix.Utils.getViewMode(); ...

    • SDK
    • Wix.PubSub

    publish(eventName, data, isPersistent) SDK 1.25.0+New EditorOld EditorLive SitePreviewWidgetFixed-Position WidgetPageModalPopup Broadcasts an event to other Site components of a multicomponent app. If the app's Site components span multiple pages, they will be notified when th...

    • Development
    • Technical Requirements

    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 ...

    • Creating a Test App

    You can create a test app to check out our platform. Important: When you're ready to move forward with your app, submit a proposal for a new app. Test apps are just for getting to know our platform - you won't be able to submit a test app for review la...

    • Infrastructure
    • App Instance ID

    The App Instance ID should be the identifier of the website, and it should be used to link the content of the app to a specific website. If your app includes App Settings, the App Settings iframe opens with the same App Instance ID as the app iframe and identifies the active user. If your a...

    • WixHive
    • Contacts

    When you have information about a contact, there are three ways to share it with the WixHive - choose the one that best describes your use case: Report information about a contact - Share any information your app collects about contact. We’ll match it to an existing contact or create a n...

    • Development
    • Developing Your App

    Apps are iframes embedded in the user’s site/dashboard. They communicate with our platform using the JavaScript SDK. Front-End Development Apps are displayed in the user’s HTML5 site/dashboard – so build the app using HTML. We don’t accept apps that use Adobe Flash. Back-End Development Y...

  • FAQ
    • FAQ

    How do I test my app before submitting? Go to your app’s page in the Dev Center and click Test App. The Editor or Dashboard opens, and you can find your app in App Market (under the Developer Apps category). Then start testing your app! I'm trying to test my app but it do...

    • Getting Started
    • New to Wix?

    It’s easy to integrate your existing app with Wix - use any language for the server-side code, and develop the app’s front end using HTML5 technologies. Note that we don’t host your app on our servers. You'll use these platforms and libraries as you develop your app: UI-lib – Our UI-lib h...

    • Monetization
    • Recurring Plans

    Wherever you have an upgrade button/link in your app, use the SDK to open the billing page directly from your app:   App Settings panel - use Wix.Settings.openBillingPage. Dashboard component - use Wix.Dashboard.openBillingPage. Only have one premium plan? Once the user upgrades, make su...

    • Development
    • Widget

    Use the App Settings panel in our UI-lib starter template as a base to create your App Settings panel. Updating the App with the User's Changes   When users change a setting in your app, update the app right away in the Wix Editor - but don’t change the app on the live site until the ...

    • Development
    • Dashboard

    A Dashboard component supports deep linking for its internal pages. Deep linking enables your app to update the content of your iframe without refreshing the whole iframe. Your Dashboard component changes its state using JavaScript and AJAX methods. After the Dashboard compon...

    • Post Launch
    • User Reviews

    When you solve a user’s issue or talk to a happy customer, ask them to rate your app. Give them a link to your app’s Reviews tab in the App Market. For example, here's the link to the Reviews tab of the Wix Hotels app. Reviews can help you get more users and conversions, a...

    • SDK
    • Wix.Activities

    getActivityById(id, onSuccess, onFailure) → Activity Object SDK 1.28.0+Dashboard Gets a specific Activity that occurred on the current site. Parameters: Name Type Description id (required) String The id of the Activity to look up onSuccess (required) Function Callback...

    • SDK
    • Wix.Contacts

    getContactById(id, onSuccess, onFailure) → Contact Object SDK 1.32.0+Dashboard Gets a specific Contact that has interacted with the current site by its id. Parameters: Name Type Description id (required) String The id of the Contact to ...

    • SDK
    • Wix.Data.Public

    Wix.Data.Public.getMulti - deprecated in SDK version 1.62.0

    • SDK
    • Wix.Analytics

    trackEvent(eventName, params) SDK 1.93.0+Live SiteWidgetFixed-Position WidgetPageWorker Reports an event in the live site to the user’s analytics tool, like Facebook Pixel or Google Analytics. Parameters: NameTypeDescriptioneventName (required)StringName of the...

    • Getting Started
    • Submitting a Proposal

    Have an existing product you think Wix users will love? Make sure your product fits with the kind of apps we’re looking for, and submit an app proposal to tell us about it. Submit your app proposal in the Dev Center, and we’ll get back to you within 15 business days. ...

    • Development
    • Fixed Position

    Users can copy the fixed-position widget as many times as they want on their website. Here’s what you should do: To distinguish between the widgets, use the compId parameter (a unique string that identifies the component, specified in the iframe query parameters). When a user copies the wi...

    • UI-lib
    • Using the UI-lib

    We release a new version of our UI-lib regularly, with new features, UI controls, and bug fixes (check out our changelog to see these updates). Make sure to update the dependencies in your project regularly. The latest version of our UI-lib uses the following dependencies: React JSXjQ...

    • SDK
    • Wix.Billing

    getProducts([options], onSuccess, [onFailure]) SDK 1.76.0+New EditorSettings PanelSettings Modal Returns a JSON with pricing information for all of your app’s packages - premium plans and in-app purchase packages.  Note: Have a dashboard ...

    • SDK
    • Wix.Preview

    openSettingsDialog([options], [onFailure]) SDK 1.45.0+PreviewWidgetFixed-Position WidgetPage Ends Preview mode and sends Wix users directly from their site’s preview to the App Settings panel in the Editor. When called with no options, uses the Widget or Page that called the m...

    • UI/UX Basics
    • Localizing Your App

    When building your app, we suggest managing all of the UI strings in one place and not adding any hardcoded strings to your code. For example: <!DOCTYPE html> <html> <head> <script type="text/javascript"> // Managing the UI strings i...

    • Infrastructure
    • App Instance

    These properties make up the data part of the Instance parameter. They’re encoded with base64 URL, so you’ll need to decode it. Field Description instanceId The instance ID of the app within Wix. Read more about the App Instance ID here. Note: To get the ins...

    • Development
    • Accessibility

    Build your app to be fully operational with the keyboard (not just mouse clicks). HTML elements already work well with the keyboard, so use HTML elements when possible. Important: Got any custom elements in <div> or <span> tags? Use the tab...

    • Development
    • Best Practices

    The Wix platform allows third-parties to integrate their apps as if they were part of the platform. However, without proper design and performance planning an app would not feel 'native' to the platform and might discourage users from using it. Planning for performance meaning fast loading ...

    • Development
    • Multicomponent

    If your app includes site components, users will see your app in the Editor App Market and then add it to their website. This will add the default component to the Editor. If your app includes more than one site component, users will be able to add the app extensions from the App Settings ...

    • Get Ready to Launch
    • Marketing Guidelines

    Write a short and engaging description that will capture the user’s attention and encourage them to try your app. Here are a few guidelines: Keep it short - up to 46 characters Speak directly to users - tell users what they can do with your app (for example...

    • Get Ready to Launch
    • Testing Guide

    You can test your mobile endpoint from your computer or mobile device. First, create a website that includes your app and publish it. You can then test your app in the published website. To test from your desktop browser, add ?showMobileView=true as query parameters to your website URL. ...

    • Infrastructure
    • Webhook

    You can receive these provisioning events: /provision/provision – a user added your app /provision/disabled – a user removed your app Webhook/provision/provision This event is posted when the app is added to a website. If the website was never saved, the event will be sent ...

    • Monetization
    • Monetizing Your App

    Every app in the Wix App Market can be free or paid, or a combination of the two. There are two ways you can earn revenue from your app: Offer a recurring plan - charge users a monthly/yearly recurring fee in order to use certain features in your app. (In Beta) Offer in-app purchases - pro...

    • Post Launch
    • Manage Your Live App

    You’ll be able to see and respond to your app’s user reviews. Don’t skimp on this part of app maintenance - user reviews are a crucial factor in your app’s success, so read reviews regularly and respond to any negative ones.  Learn more>> We make it easy for you to stay on top of revi...

    • HTTP API
    • Using the HTTP API

    Every call is sent with a digital signature in the x-wix-signature header, for authentication purposes. To encode the signature: Sort all request parameters by parameter name (in ascending alphanumeric order) and concatenate their values with only a line break (n) as a separator. The reque...

    • Glossary

    The unique identifier of the app within the website.

    • UI-lib
    • UI Controls

    Panel Tabs The panel tabs UI control is a container for the tabs and action links in your app’s navigation menu. Our starter template alread...

    • HTTP API
    • Contacts

    Version 2.0.0 : Reconciles Contact information with that of the WixHive's. Use this when your app has information about a site visitor that may already be registered as a Contact as part of the WixHive. Your app should provide as much information as possible so that we will find the best m...

    • HTTP API
    • Activities

    Returns the Activity stream for a given Contact, referenced by the contact's unique ID. Activities will be returned in descending order from the most recent Activity, in cursored form, and can be filtered by date ranges. Parameters: NameData TypeParameter TypeDescriptioncontactId (required)...

    • UI-lib
    • About the UI-lib

    Our UI-lib has everything you need to create the App Settings panel for your site component:   A starter template for the panel - in React JSX, jQuery, and AngularJS A collection of ready-made, beautiful UI controls (buttons, checkboxes, etc.) Step-by-step guidelines that will show y...

    • Development
    • Security & Privacy

    When Wix calls your app endpoint, check (on the server side) that the signature was signed by Wix. Here’s how to do that (you can also check out these parsing examples): Take the data part of the instance parameter and sign it using your secret key. Let’s call this value “A”. Use base64ur...

    • Development
    • Security & Privacy

    Make sure that no one can enter malicious code anywhere in your app. Check your app’s dashboard, settings panel, and site component for all input fields where users/site visitors can enter text. (For example: comment fields, forms, search fields, title/descriptions fields, etc.)

    • Post Launch

    Now that your app is live in the Wix App market, here's a brief look into what's next for your app.

    • Get Ready to Launch
    • App Review

    We’ll do our best to review your app as quickly as possible.  Here’s what to do on your end to make the review process short and sweet: As you create mockups, follow our guidelines and ask questions. As you go through our UI/UX guidelines to create your mockups, reach out to your account m...

    • UI/UX Basics
    • Mockup Review

    We’ll do our best to review your mockups as quickly as possible.  Here’s what to do on your end to make the review process short and sweet: As you create mockups, follow our guidelines and ask questions. As you go through our UI/UX guidelines to create your mockups, reach out to your accou...

    • Get Ready to Launch
    • Add your app details

    Add information about your app and your company in the App Info tab: Upload Icons and App Market Images: App Icon - Add your app icon. Image for Marketing - Add your app banner image. Add Promotional text for your app - add your app’s short description and a list of benefits for upgradi...

    • Getting Started
    • Launch Process

    Once we approve your app’s mockups, you can start developing your app! Stick to the mockups we finalized together. As you develop, follow our testing plans to thoroughly test your app. Make sure it works well and has no bugs/performance issues. While you’re in development, we’ll also send y...

    • Launch Requirements
    • Partner Agreement

    In addition to the terms of this Agreement, the general Terms of Use of Wix, which can be reviewed at http://www.wix.com/About/Terms-Of-Use (the “Terms of Use”), and the terms and conditions of Wix’s Privacy Policy, which can be reviewed at http://www.wix.com/about/privacy, (both as may be ...

    • Post Launch

    Important: If you're a Wix site owner, go to the Wix Help Center to find out how to prepare your site for GDPR. The info below is only relevant to companies who launched an app in the Wix App Market.

    • Getting Started
    • Planning Your App

    Apps in Wix work together by sharing information about the user’s contacts and site visitor activity (purchases, reservations, etc). Not only does this create a seamless experience for users - but you can also use this information to give your app a nice boost in functionality. For example...

    • UI-lib

    Important: Using the old UI-lib? Contact your account manager to switch over to our new UI-lib. Learn more.

    • UI-lib

    Important: Using the old UI-lib? Contact your account manager to switch over to our new UI-lib. Learn more.

    • HTTP API
    • In-App Purchases

    Returns information about the user’s purchase history. Important: Before using this API endpoint, learn more about how to implement in-app purchases. Parameters: NameData TypeParameter TypeDescriptionappDefId (required)Str...

    • UI/UX Basics
    • Creating Your Mockups

    Create mockups to show us your app’s full flow inside Wix. We want to see your app’s entire experience: how Wix users will set up your app, how site visitors will use your app, etc. Here’s how: Create a Wix site. Since the mockups will show your app in the Wix Editor/Dashboard, first creat...

    • Post Launch
    • Promote Your App

    You can send out marketing emails to let Wix users know about new features and more. Just make sure to follow these guidelines: Let users unsubscribe. Make sure the email has an unsubscribe option. Make it clear to users that the email is from you. Users should understand from your email ...

    • Get Ready to Launch
    • Submit Your App

    Before you submit your app, go through this checklist: The app was developed according to the approved mockups and content. Go over your mockups to check that your app is pixel-perfect. If we sent you any updated marketing or UI content, make sure you're using the new content.  All app re...

    • Getting Started
    • Apps We’re Looking For

    Have an existing product you want to integrate with us? Learn more about our launch process, then submit a proposal to share your product with us.

    • Development
    • Worker

    Query parameters for the Worker iframe: [endpoint]?instance=[signed-instance-data]&cacheKiller=[cacheKiller]&compId=[compId]&viewMode=[viewMode]&locale=[locale]&deviceType=[device]&endpointType=worker Name Value Comments endpoint...

    • Post Launch
    • Data Protection (GDPR)

    Starting in May 2018, the EU will have stricter privacy requirements, according to a new regulation known as the EU General Data Protection Regulation (GDPR). What does this mean for your app? Once GDPR takes effect, Wix users may contact you about accessing, changing, or deleting any perso...

    • Launch Requirements

    We recommend that you read through our Partner Agreement before you get started, so that you understand the terms and conditions of launching your app in the Wix App Market. Important: We’ll need your signature when you first send us your mockups. W...

    • UI-lib

    Important: Using the old UI-lib? Contact your account manager to switch over to our new UI-lib. Learn more.

    • HTTP API

    Note: Before using these API endpoints, learn more about how to use WixHive contacts in your app.

    • SDK

    Important: Wix.Contacts methods are only available from the Dashboard endpoint.

    • HTTP API

    Note: Before using these API endpoints, learn more about how to use WixHive activities in your app.

    • UI/UX Basics

    Important: During development, you'll build the App Settings panel using our UI-lib. If your app is currently using our old UI-lib, contact your account manager to switch over to our new UI-lib.