As Wix APIs evolve, Wix releases new versions that introduce features, improvements, and occasionally breaking changes. Versioning helps you manage updates and maintain compatibility in your projects.
- New versions are released at the module or submodule level.
For example, the latest version of Wix Bookings' Bookings API might be v3, while the Bookings Attendance API might be v2.
- When Wix releases a new version of an API, the previous version is deprecated but remains available.
- Deprecated methods are marked in the documentation.
Within the same major version, Wix may introduce non-breaking changes that enhance functionality without disrupting existing implementations. Your code should be designed to handle these updates:
- New response fields: API responses may include additional fields over time. Ensure your code doesn't break when encountering unexpected fields in responses.
- New request fields in service plugins: Service plugin requests may add new fields. Your service plugin implementations should gracefully ignore fields they don't recognize.
- New enum values: Enums may be extended with new values. Handle unknown enum values appropriately, such as by treating them as a default case.
Wix may deprecate API components at various levels, including:
- Entire APIs or modules
- Specific modules or submodules
- Individual entities, methods, or events
- Specific parameters in methods
When deprecation occurs, it follows a structured process to ensure you have time to adapt:
- Advance notice: Impending deprecations are noted in the API reference before they take effect, including information about recommended alternatives, giving you time to plan for changes.
- Deprecated items remain functional: Your existing code will continue to work. Wix doesn't remove or "sunset" deprecated APIs, ensuring backward compatibility.
- No new development recommended: While deprecated items still work, you should avoid using them in new projects and consider migrating existing implementations to recommended alternatives.
- Documentation visibility: Deprecated items are hidden from the main API reference documentation by default, but you can view them by enabling the Show Deprecated Items toggle in the top menu of the documentation portal.
- Changelog updates: Deprecations are documented in the changelog to help you track changes over time.