About Wix APIs
Wix APIs act as the bridge between your app and the Wix ecosystem, enabling communication and integration between your app and Wix.
With the Wix APIs, you can:
- Transfer data between your app and the site it's installed on.
- Extend Wix business solutions, such as Wix eCommerce or Wix Bookings.
- Customize your app’s interactions with site visitors.
Important: Use of Wix APIs are subject to the Wix App Market guidelines.
API categories
Wix offers a variety of APIs that enable integration with different areas of the Wix ecosystem, including:
- Business solutions: Interact with Wix’s business solutions, such as eCommerce, Bookings, Events, and Restaurants.
- Payments: Manage payments with Pricing Plans, Payments, and Billing APIs.
- CRM and Members: Interact with and manage site contacts and members.
- Data: Work with data stored in Wix-hosted and external databases.
- Automations: Streamline work processes and send notifications.
API technologies
Wix offers the following API technologies for integrating your app with Wix:
Each API technology offers a similar set of APIs, and each API technology is suitable for use in different contexts:
REST
Wix REST APIs use standard HTTPS protocols and authentication, and return JSON-encoded responses. REST APIs can be called from any programming language, and are the most common choice of API if you’re self-hosting your app and developing it in a language other than JavaScript.
JavaScript SDK
The Wix JavaScript SDK consists of npm packages containing wrapper functions for Wix REST APIs. The SDK is useful if you're building a Wix-hosted app using the Wix CLI, or you're self-hosting your app and using JavaScript.
GraphQL
You can streamline your API calls using GraphQL. With GraphQL, the API response is clean, concise, and includes only the data that you need.
Velo with Blocks
If you’re building your app in Wix Blocks, you can access Wix APIs via Velo, a powerful JavaScript-based developer platform.
Events
Wix APIs include events, such as webhooks. Events are automated responses including a payload that are sent to your app when specific site actions occur.
Service Plugins (formerly SPIs)
Service Plugins are a way to inject custom logic into Wix backend APIs. You can set up Service Plugins in the Wix Dev Center and handle them on your server.