Versioning is an important part of the AutoLeap API. It ensures that updates and improvements do not break your existing integrations. A new API version is released only when changes could potentially break an integration. By including the version in the URL, you can safely continue using an older version while new features or non-breaking changes are introduced.
The AutoLeap API is versioned, and the version is included in the base URL.
Current Version
The current version is v2, which appears as the first part of the path in all requests:
For example, the Base URL is: https://partnerapi.myautoleap.com/v2
Examples of breaking changes include:
- Removing an operation
- Removing or renaming a parameter
- Removing or renaming a response field
- Adding a new required parameter
- Making a previously optional parameter required
- Changing the type of a parameter or response field
- Removing enum values
- Modifying pagination rules (e.g., changing default limits)
- Changing error codes or the error response structure
- Requiring new scopes or permissions on existing endpoints
- Altering sorting defaults (e.g., changing from ascending to descending by
createdAt) - Changing data formats
Examples of non-breaking changes include:
- Adding a new operation
- Adding an optional parameter or request header
- Adding a response field or response header
- Adding enum values