Wix API Essential Guide

What type of API does Wix provide?

Wix offers multiple types of APIs for developers to integrate with their platform:

1. REST API:

   • Wix provides REST APIs that use standard HTTPS protocols and authentication, returning JSON-encoded responses.
   • These are the most common choice for developers self-hosting their apps and using languages other than JavaScript.

2. GraphQL API:

   • Wix offers a GraphQL API that allows developers to streamline their API calls.
   • The GraphQL API provides clean, concise responses that include only the requested data.
   • It is exposed over REST and can be used alongside the REST API for querying and modifying the same data.

3. JavaScript SDK:

   • Wix provides a JavaScript SDK consisting of npm packages with wrapper functions for their REST APIs.

4. Velo with Blocks:

   • For apps built using Wix Blocks, developers can access Wix APIs via Velo, a JavaScript-based developer platform.

Does the Wix API have webhooks?

Availability of Webhooks

The official Wix API includes webhooks.

Types of Events You Can Subscribe To

Wix offers webhooks for various types of events, including:

1. Site operations events:

   • Product creation
   • Purchases

2. App-related events:

   • App installation
   • Plan upgrades

3. eCommerce events:

   • Order cancellation

4. Other events:

   • Many other events are available in the REST API and JavaScript SDK reference, as well as app-level events in the App Instances API.

Key Points to Consider

1. Webhook Payload Format:

   • Event data is sent as a JSON Web Token (JWT) in the body of the webhook request.
   • The JWT is signed, allowing you to verify its authenticity as originating from Wix.

2. Webhook Subscription:

   • You can subscribe to webhooks through the Wix Dev Center.
   • When subscribing, you need to specify a callback URL where Wix will send the event data.

3. Event Handling:

   • Wix provides a JavaScript SDK with methods to handle specific events.

4. Best Practices:

   • Send a status 200 response upon receipt of a webhook.
   • Make periodic API requests to confirm webhooks are being received and are accurate.
   • Ensure your server can handle out-of-order and duplicate webhooks.
   • Update webhooks promptly when notified of outdated webhooks.

5. Event Delivery and Redundancy:

   • Wix has a resend policy for failed webhook deliveries, with up to 12 additional attempts over a period of time.
   • Due to the redundancy measures, you might receive duplicate events, so design your app to handle this.

6. Webhook Customization:

   • When setting up a webhook, you can choose to send all available data or customize the structure to send only specific data.

Rate Limits and other limitations

Based on the search results provided, I can summarize the key points about the API Rate Limits of the Wix API:

Request Limits

Wix imposes limits on the number of data requests a site can make per minute. There are separate quotas for read requests and write requests. Once a site reaches its quota, subsequent requests during the same minute are not processed and return an error.

Key points to consider:

• Different API functions count towards either the read or write quota.
• Each use of include in a query counts as a separate read request.

Processing Time Limits

Wix also limits the amount of processing time a site can use per minute. This is calculated based on the complexity of the requests, the amount of data they process, and the volume of requests.

Request Timeout

There is a limit on how long the code on the Wix server can run before it times out and returns an error instead of the intended result.

Data Storage Limits

1. Collection Items: There is a limit on the total number of collection items a site can have.
2. Data Collections: Sites are limited to a maximum number of collections.
3. Data Storage: There is a limit to the amount of data that can be stored on a site.
4. Single Item Size: The maximum size for a single collection item is 512 KB.

Other Limitations

1. Database Structure: Most sites use multi-tenant databases, which impose limits on storage, read/write requests, and indexing resources.
2. Data Indexes: The number and type of indexes that can be created depend on the site's plan.
3. External Database Integration: Available for higher-tier plans, but may be restricted if downgrading.

Best Practices

1. Optimize Requests: To avoid reaching limits, it's recommended to optimize data requests.
2. Optimize Data Storage: To avoid reaching storage limits, optimize data storage practices.
3. Consider Upgrading: Higher-tier plans offer larger limits for data requests and storage.

It's important to note that specific numerical limits are not provided in the search results. These limits may vary depending on the specific Wix plan a site is using. For precise limit values, it would be best to consult the official Wix documentation or contact Wix support directly.

Latest API Version

I apologize, but I'm unable to provide a definitive answer about the most recent version of the Wix API based on the search results provided. The search results don't contain any specific information about Wix API versions. However, I can offer some general information and suggestions:

General Information

• Wix regularly updates its API to introduce new features, improve performance, and fix bugs.
• API versions are typically indicated in documentation or in API calls to ensure compatibility.

Suggestions for Finding the Latest Version

1. Check the official Wix Developer Documentation:

   • Visit the Wix Developers website (https://dev.wix.com)
   • Look for sections related to API reference or changelog

2. Use the Wix API Explorer:

   • If available, the API Explorer often shows the latest version of endpoints

3. Contact Wix Support:

   • For the most up-to-date information, reaching out to Wix support directly might be the best option

Best Practices

• Always use the latest stable version of the API for new projects
• Keep track of deprecation notices for older versions
• Subscribe to Wix developer newsletters or follow their social media for updates

To get the most accurate and current information about the Wix API version, I recommend visiting the official Wix Developers website or contacting Wix support directly.

How to get a Wix developer account and API Keys?

To get a developer account for Wix and create an API integration:

1. Sign up for a Wix Developer Account

   • Go to the Wix Developer Center (https://dev.wix.com/) and sign up for a Wix Developer account.

2. Set Up Your App in the Dev Center

   • Once logged in, set up an app in the Dev Center.

3. Configure Your App

   • In the Dev Center, configure your app:
     • Set up permissions
     • Sign up for webhooks
     • Set up OAuth
     • Add extensions to extend Wix functionality

4. Develop Your App

   • Develop your app using:
     • Wix CLI for more advanced development
     • Wix Blocks for simpler apps
     • Your own tech stack for self-hosted apps

5. Integrate with Wix APIs

   • Wix offers various API technologies for integration:
     • REST APIs
     • JavaScript SDK
     • GraphQL
     • Velo for Blocks

6. Test Your App

   • Use the Dev Center or your chosen development environment to test your app.

7. Launch Your App (if applicable)

   • For public apps:
     • Set up your App Market listing
     • Price your app
     • Create promotional assets
     • Submit your app for Wix approval

The Wix Dev Center is the central hub for managing your app and its integration with the Wix ecosystem. You can create both public and private apps, with different requirements for each. Wix offers a variety of APIs for different purposes, including business solutions, payments, CRM, data management, and automations. Make sure to follow the Wix App Market guidelines when using Wix APIs.

What can you do with the Wix API?

Here are the key data models you can interact with using the Wix API:

Collections

• Create, read, update and delete database collections
• Query and filter collection data
• Set permissions on collections
• Define collection schema and fields

Items

• Insert new items into collections
• Get individual items by ID
• Find multiple items matching query criteria
• Update existing items
• Remove items from collections
• Count items matching filters

Queries

• Build complex queries using WixDataQuery object
• Filter results
• Sort results
• Paginate results
• Aggregate data

Media

• Store and retrieve media files like images and videos
• Associate media with collection items

Hooks

• Register hooks to run code before/after collection operations
• Customize behavior for insert, update, remove actions

Permissions

• Set read/write permissions on collections and items
• Control access for different user roles

External Databases

• Connect external databases as collections
• Query external data through Wix API

Schemas

• Define collection schemas with fields and data types
• Retrieve schema metadata

The Wix Data API provides a comprehensive set of capabilities to interact with data models, allowing you to build robust database-driven applications on the Wix platform. The key is understanding how to leverage collections, queries, and permissions to structure and access your data effectively.